Skip to content

asPieceCID

asPieceCID(pieceCidInput): PieceLink | null

Defined in: packages/synapse-core/src/piece.ts:124

Convert a PieceCID input (string or CID) to a validated CID This is the main function to use when accepting PieceCID inputs

ParameterTypeDescription
pieceCidInputstring | PieceLink | CID<unknown, number, number, Version> | null | undefinedPieceCID as either a CID object or string

PieceLink | null

The validated PieceCID CID or null if not a valid PieceCID