Skip to content

Commit f22570d

Browse files
committed
chore: pr comments
1 parent 26b8e1a commit f22570d

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

docs/sdks/tigris/using-sdk.mdx

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -471,7 +471,7 @@ console.log(allFiles);
471471

472472
## Listing buckets
473473

474-
`listBuckets` function can be used to list all buckets in the account.
474+
`listBuckets` function can be used to list all buckets user has access to.
475475

476476
### `listBuckets`
477477

@@ -485,24 +485,23 @@ listBuckets(options?: ListBucketsOptions): Promise<TigrisStorageResponse<ListBuc
485485

486486
#### `options`
487487

488-
| **Parameter** | **Required** | **Values** |
489-
| ----------------------------------------- | ------------ | --------------------------------------------------------------------------- |
490-
| limit | No | The maximum number of buckets to return. |
491-
| paginationToken | No | The pagination token to continue listing buckets from the previous request. |
492-
| config | No | A configuration object to override the |
493-
| [default configuration](#authentication). |
488+
| **Parameter** | **Required** | **Values** |
489+
| --------------- | ------------ | -------------------------------------------------------------------------------- |
490+
| limit | No | The maximum number of buckets to return. |
491+
| paginationToken | No | The pagination token to continue listing buckets from the previous request. |
492+
| config | No | A configuration object to override the [default configuration](#authentication). |
494493

495-
In case of successful `list`, the `data` property will be set to the list of
496-
buckets and contains the following properties:
494+
In case of successful `listBuckets`, the `data` property will be set to the list
495+
of buckets and will contain the following properties:
497496

498497
- `buckets`: The list of buckets
499498
- `owner`: The owner of the buckets
500-
- `paginationToken`: The pagination token to continue listing objects for next
501-
page.
499+
- `paginationToken`: The pagination token to continue listing buckets for the
500+
next page.
502501

503502
### Examples
504503

505-
#### List buckets
504+
#### Listing buckets
506505

507506
```ts
508507
const result = await listBuckets();
@@ -533,15 +532,15 @@ removeBucket(bucketName: string, options?: RemoveBucketOptions): Promise<TigrisS
533532

534533
| **Parameter** | **Required** | **Values** |
535534
| ------------- | ------------ | -------------------------------------------------------------------------------- |
536-
| force | No | When provided, forcefully delete the bucket |
535+
| force | No | When provided, forcefully delete the bucket. |
537536
| config | No | A configuration object to override the [default configuration](#authentication). |
538537

539538
In case of successful `removeBucket`, the `data` property will be set to
540539
`undefined` and the bucket will be deleted.
541540

542541
### Examples
543542

544-
#### Delete a bucket
543+
#### Deleting a bucket
545544

546545
```ts
547546
const result = await removeBucket("my-bucket");

0 commit comments

Comments
 (0)