sp
Service Provider HTTP Operations
Example
Section titled “Example”import * as SP from '@filoz/synapse-core/sp'Namespaces
Section titled “Namespaces”Classes
Section titled “Classes”| Class | Description |
|---|---|
| AbortError | - |
| NetworkError | - |
| TimeoutError | - |
Type Aliases
Section titled “Type Aliases”| Type Alias | Description |
|---|---|
| AddPiecesResponse | - |
| AddPiecesSuccess | - |
| DataSetCreatedResponse | - |
| DataSetCreateSuccess | - |
| SPPiece | - |
| SPPieceWithUrl | - |
| UploadPieceResponse | - |
| UploadPieceStreamingOptions | - |
Variables
Section titled “Variables”| Variable | Description |
|---|---|
| FACTOR | - |
| MIN_TIMEOUT | - |
| RETRIES | - |
Functions
Section titled “Functions”| Function | Description |
|---|---|
| addPieces | Add pieces to a data set on the PDP API. |
| createDataSet | Create a data set on PDP API |
| createDataSetAndAddPieces | Create a data set and add pieces to it on PDP API |
| deletePiece | Delete a piece from a data set on the PDP API. |
| downloadPiece | Download a piece and verify from the PDP API. |
| findPiece | Find a piece on the PDP API. |
| getDataSet | Get a data set from the PDP API. |
| getPiecesForDataSet | Get the pieces for a data set from the PDP API. |
| ping | Ping the PDP API. |
| resetTimeout | - |
| setTimeout | - |
| uploadPiece | Upload a piece to the PDP API. |
| uploadPieceStreaming | Upload piece data using the 3-step CommP-last streaming protocol. |
| waitForAddPiecesStatus | Wait for the add pieces status. |
| waitForDataSetCreationStatus | Wait for the data set creation status. |