asLegacyPieceCID

function asLegacyPieceCID(pieceCidInput):
  | LegacyPieceLink
  | null;

Defined in: packages/synapse-sdk/src/piece/piece.ts:126

Convert a LegacyPieceCID input (string or CID) to a validated CID This function can be used to parse a LegacyPieceCID (CommPv1) or to downgrade a PieceCID (CommPv2) to a LegacyPieceCID.

Parameters

Parameter	Type	Description
pieceCidInput	| string | PieceLink | CID<unknown, number, number, Version> | LegacyPieceLink	LegacyPieceCID as either a CID object or string

Returns

| LegacyPieceLink | null

The validated LegacyPieceCID CID or null if not a valid LegacyPieceCID