PullBaseOptions

Defined in: packages/synapse-sdk/src/types.ts:676

Options shared by every form of PullOptions

Properties

from

from: PullSource

Defined in: packages/synapse-sdk/src/types.ts:678

Source provider to pull from (URL or context with getPieceUrl)

---

onProgress?

optional onProgress?: (pieceCid, status) => void

Defined in: packages/synapse-sdk/src/types.ts:682

Pull progress callback

Parameters

Parameter	Type
pieceCid	PieceCID
status	PullStatus

Returns

void

---

signal?

optional signal?: AbortSignal

Defined in: packages/synapse-sdk/src/types.ts:680

Optional AbortSignal

---

timeout?

optional timeout?: number

Defined in: packages/synapse-sdk/src/types.ts:684

Total time in milliseconds to wait for the pull to finish. Defaults to 2 hours.