Skip to content
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion packages/s3-store/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,14 @@ by setting `partSize` and `minPartSize` to the same value.
Can not be lower than 5MiB or more than 5GiB.

The server calculates the optimal part size, which takes this size into account, but
may increase it to not exceed the S3 10K parts limit.
may increase it to not exceed the `options.maxMultipartParts` parts limit.

#### `options.maxMultipartParts`

The maximum number of parts allowed in a multipart upload. Defaults to 10,000.
Some S3 providers have non-standard restrictions on the number of parts in a multipart
upload. For example, AWS S3 has a limit of 10,000 parts, but some S3 compatible providers
have a limit of 1,000 parts.

#### `options.s3ClientConfig`

Expand Down Expand Up @@ -226,6 +233,17 @@ const s3Store = new S3Store({
})
```

### Example: use with Scaleway Object Storage

`@tus/s3-store` can be used with Scaleway Object Storage but with some additional configuration. Scaleway Object Storage has a limit of 1000 parts in a multipart upload.

```ts
const s3Store = new S3Store({
maxMultipartParts: 1000,
// ...
})
```

## Types

This package is fully typed with TypeScript.
Expand Down