checkAddPiecesFit

checkAddPiecesFit(options): AddPiecesFitResult

Defined in: packages/synapse-core/src/sp/add-pieces-fits.ts:92

Whether a candidate piece list fits in one addPieces / createAndAdd message, and why not.

Same checks as addPiecesFits, but returns the failure reason. Invalid metadata is reported with the index of the first bad piece instead of throwing.

Parameters

Parameter	Type	Description
`options`	`LimiterOptions`	checkAddPiecesFit.OptionsType

Returns

AddPiecesFitResult

The fit result checkAddPiecesFit.OutputType

Example

import { checkAddPiecesFit } from '@filoz/synapse-core/sp'

const result = checkAddPiecesFit({ kind: 'addPieces', dataSetId, pieces })
if (!result.fits && result.reason === 'invalid-metadata') {
  console.log('bad piece at', result.index)
}