Skip to content
focFilecoin Onchain Cloud Documentation

OptionsType

OptionsType = object

Defined in: packages/synapse-core/src/sp/find-piece.ts:8

Properties

Section titled “Properties”

pieceCid

Section titled “pieceCid”

pieceCid: PieceCID

Defined in: packages/synapse-core/src/sp/find-piece.ts:12

The piece CID to find.

poll?

Section titled “poll?”

optional poll?: boolean

Defined in: packages/synapse-core/src/sp/find-piece.ts:22

Whether to poll the request. Defaults to false.

pollInterval?

Section titled “pollInterval?”

optional pollInterval?: number

Defined in: packages/synapse-core/src/sp/find-piece.ts:24

The poll interval in milliseconds. Defaults to 1 second.

retryCount?

Section titled “retryCount?”

optional retryCount?: number

Defined in: packages/synapse-core/src/sp/find-piece.ts:18

The number of retries. Defaults to polling until timeout when poll is true.

retryDelay?

Section titled “retryDelay?”

optional retryDelay?: number

Defined in: packages/synapse-core/src/sp/find-piece.ts:20

The delay between retries in milliseconds. Defaults to pollInterval when poll is true.

serviceURL

Section titled “serviceURL”

serviceURL: string

Defined in: packages/synapse-core/src/sp/find-piece.ts:10

The service URL of the PDP API.

signal?

Section titled “signal?”

optional signal?: AbortSignal

Defined in: packages/synapse-core/src/sp/find-piece.ts:14

The signal to abort the request.

timeout?

Section titled “timeout?”

optional timeout?: number

Defined in: packages/synapse-core/src/sp/find-piece.ts:16

The timeout in milliseconds. Defaults to 5 minutes.