OptionsType

OptionsType = object

Defined in: packages/synapse-core/src/sp/upload-streaming.ts:11

Properties

data

data: UploadPieceStreamingData

Defined in: packages/synapse-core/src/sp/upload-streaming.ts:15

The data to upload.

---

onProgress?

optional onProgress?: (bytesUploaded) => void

Defined in: packages/synapse-core/src/sp/upload-streaming.ts:19

The progress callback.

Parameters

Parameter	Type
bytesUploaded	number

Returns

void

---

pieceCid?

optional pieceCid?: PieceCID

Defined in: packages/synapse-core/src/sp/upload-streaming.ts:21

The piece CID to upload.

---

retryCount?

optional retryCount?: number

Defined in: packages/synapse-core/src/sp/upload-streaming.ts:25

The number of retries. Defaults to 2.

---

retryDelay?

optional retryDelay?: number

Defined in: packages/synapse-core/src/sp/upload-streaming.ts:27

The delay with exponential backoff between retries in milliseconds. Defaults to RETRY_CONSTANTS.RETRY_DELAY.

---

serviceURL

serviceURL: string

Defined in: packages/synapse-core/src/sp/upload-streaming.ts:13

The service URL of the PDP API.

---

signal?

optional signal?: AbortSignal

Defined in: packages/synapse-core/src/sp/upload-streaming.ts:23

The signal to abort the request.

---

size?

optional size?: number

Defined in: packages/synapse-core/src/sp/upload-streaming.ts:17

The size of the data. If defined, it will be used to set the Content-Length header.