Skip to content

Commit 39c2015

Browse files
committed
chore: PR comments
1 parent 256fb99 commit 39c2015

File tree

3 files changed

+18
-7
lines changed

3 files changed

+18
-7
lines changed

docs/sdks/tigris/examples.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ export default function ClientUpload() {
198198
setProgress(0);
199199
if (file) {
200200
const result = await upload(`${file.name}`, file, {
201-
url: "/api/test",
201+
url: "/api/upload",
202202
access: "private",
203203
onUploadProgress: ({ loaded, total, percentage }) => {
204204
setProgress(percentage);

docs/sdks/tigris/index.mdx

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,21 @@
33
import Tabs from "@theme/Tabs";
44
import TabItem from "@theme/TabItem";
55

6-
Tigris Storage SDK is a simplified wrapper around Tigris Object Storage API. It
7-
provides a simpler interface and minimal configuration that lets you get started
8-
quickly and integrate Tigris into your application. It offers all the
9-
functionality of Tigris, but with a simpler interface.
6+
Tigris Storage SDK provides a simple interface and minimal configuration that
7+
lets you get started quickly and integrate Tigris into your application. It is
8+
built on top of Tigris Object Storage API and offers all the functionality of
9+
Tigris.
1010

1111
## Use Cases
1212

1313
Tigris Storage SDK is geared (but not limited to) towards application developers
14-
who needs to store objects that:
14+
who need to store objects that:
1515

1616
- Are programmatically uploaded or generated at build time, for display and
1717
download such as avatars, screenshots, cover images and videos
1818
- Are larger and not practical to store in the database, such as images, videos,
1919
documents, etc.
2020
- That needs to be retrieved frequently across different regions
21-
- break your wallet by paying egress fees
2221

2322
## Getting Started
2423

docs/sdks/tigris/using-sdk.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,8 @@ put(path: string, body: string | ReadableStream | Blob | Buffer, options?: PutOp
100100
Blob based on these supported body types
101101
- `options`: (Optional) A JSON object with the following optional parameters:
102102

103+
#### `options`
104+
103105
| **Parameter** | **Required** | **Values** |
104106
| ------------------ | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
105107
| access | No | The access level for the object. Possible values are `public` and `private`. |
@@ -188,6 +190,8 @@ get(path: string, format?: "string" | "file" | "stream", options?: GetOptions):
188190
values are `string`, `file`, and `stream`.
189191
- `options`: (Optional) A JSON object with the following optional parameters:
190192

193+
#### `options`
194+
191195
| **Parameter** | **Required** | **Values** |
192196
| ------------------ | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
193197
| contentDisposition | No | Set the content disposition of the object. Possible values are `inline` and `attachment`. Default is `inline`. Use `attachment` for downloadable files. |
@@ -264,6 +268,8 @@ head(path: string, options?: HeadOptions): Promise<TigrisStorageResponse<HeadRes
264268
- `path`: (Required) A string specifying the path to the object
265269
- `options`: (Optional) A JSON object with the following optional parameters:
266270

271+
#### `options`
272+
267273
| **Parameter** | **Required** | **Values** |
268274
| ------------- | ------------ | -------------------------------------------------------------------------------- |
269275
| config | No | A configuration object to override the [default configuration](#authentication). |
@@ -316,6 +322,8 @@ remove(path: string, options?: RemoveOptions): Promise<TigrisStorageResponse<voi
316322
- `path`: (Required) A string specifying the path to the object
317323
- `options`: (Optional) A JSON object with the following optional parameters:
318324

325+
#### `options`
326+
319327
| **Parameter** | **Required** | **Values** |
320328
| ------------- | ------------ | -------------------------------------------------------------------------------- |
321329
| config | No | A configuration object to override the [default configuration](#authentication). |
@@ -353,6 +361,8 @@ getPresignedUrl(path: string, options: GetPresignedUrlOptions): Promise<TigrisSt
353361
- `path`: (Required) A string specifying the path to the object
354362
- `options`: (Optional) A JSON object with the following optional parameters:
355363

364+
#### `options`
365+
356366
| **Parameter** | **Required** | **Values** |
357367
| ------------- | ------------ | ---------------------------------------------------------------------------------------- |
358368
| method | No | Specify the operation to use for the presigned URL. Possible values are `get` and `put`. |
@@ -401,6 +411,8 @@ list(options?: ListOptions): Promise<TigrisStorageResponse<ListResponse, Error>>
401411

402412
- `options`: (Optional) A JSON object with the following optional parameters:
403413

414+
#### `options`
415+
404416
| **Parameter** | **Required** | **Values** |
405417
| ----------------------------------------- | ------------ | ------------------------------------------------------------------------------- |
406418
| limit | No | The maximum number of objects to return. By default, returns up to 100 objects. |

0 commit comments

Comments
 (0)