createChunkedSender
danger
Internal API - Not intended for use outside rpldy packages.
Packageβ
Installationβ
- npm
- Yarn
- pnpm
npm install @rpldy/chunked-sender
yarn add @rpldy/chunked-sender
pnpm add @rpldy/chunked-sender
Detailsβ
type ChunkedSender = {
send: SendMethod;
};
type createChunkedSender = (options: ChunkedOptions) => ChunkedSender;
Optionsβ
| Name (* = mandatory) | Type | Default | Description |
|---|---|---|---|
| chunked | boolean | true | chunk uploads. setting to false will return to default sending behavior |
| chunkSize | number | 5242880 | the chunk size. relevant when uploaded file is larger than the value |
| retries | number | 0 | how many times to retry sending a failed chunk |
| parallel | number | 0 | how many (chunk) requests to send simultaneously |