Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update bucketExists in API.md #821

Merged
merged 1 commit into from
Jan 24, 2020
Merged
Changes from all 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
Update API.md
Since `bucketExists` was [promisified](https://github.com/minio/minio-js/blob/518e5a8815dd579f3fcd2d2a4f4cb2599ad3d580/src/main/minio.js#L2115), it should be reflected in the API document.
weeix authored Jan 21, 2020
commit 99817d3a61243ddc2faefcb7fe6dabe3c17303ae
4 changes: 2 additions & 2 deletions docs/API.md
Original file line number Diff line number Diff line change
@@ -156,7 +156,7 @@ minioClient.listBuckets(function(err, buckets) {
```

<a name="bucketExists"></a>
#### bucketExists(bucketName, callback)
#### bucketExists(bucketName[, callback])

Checks if a bucket exists.

@@ -167,7 +167,7 @@ __Parameters__
| Param | Type | Description |
|---|---|---|
| `bucketName` | _string_ | Name of the bucket. |
| `callback(err, exists)` | _function_ | `exists` is a boolean which indicates whether `bucketName` exists or not. `err` is set when an error occurs during the operation. |
| `callback(err, exists)` | _function_ | `exists` is a boolean which indicates whether `bucketName` exists or not. `err` is set when an error occurs during the operation. If no callback is passed, a `Promise` is returned. |

__Example__