From af3da879d0b09fd4989160b7be9da4f762eb6fe0 Mon Sep 17 00:00:00 2001 From: Inian Date: Wed, 12 Apr 2023 14:43:45 +0800 Subject: [PATCH] fix: update docs --- src/packages/StorageBucketApi.ts | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/src/packages/StorageBucketApi.ts b/src/packages/StorageBucketApi.ts index c9c1d9e..ad4a780 100644 --- a/src/packages/StorageBucketApi.ts +++ b/src/packages/StorageBucketApi.ts @@ -74,8 +74,12 @@ export default class StorageBucketApi { * * @param id A unique identifier for the bucket you are creating. * @param options.public The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private. - * @param options.fileSizeLimit specifies the file size limit that this bucket can accept during upload, pass null to remove the constraint - * @param options.allowedMimeTypes specifies the allowed mime types that this bucket can accept during upload, pass null to remove the constraint + * @param options.fileSizeLimit specifies the max file size that can be uploaded to this bucket. + * The global file size limit takes precedence over this value. + * The default value is null, which doesn't set a per bucket file size limit. + * @param options.allowedMimeTypes specifies the allowed mime types that this bucket can accept during upload. + * The default value is null, which allows files with all mime types to be uploaded. + * Each mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png. * @returns newly created bucket id */ async createBucket( @@ -125,8 +129,12 @@ export default class StorageBucketApi { * * @param id A unique identifier for the bucket you are updating. * @param options.public The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. - * @param options.fileSizeLimit specifies the file size limit that this bucket can accept during upload, pass null to remove the constraint - * @param options.allowedMimeTypes specifies the allowed mime types that this bucket can accept during upload, pass null to remove the constraint + * @param options.fileSizeLimit specifies the max file size that can be uploaded to this bucket. + * The global file size limit takes precedence over this value. + * The default value is null, which doesn't set a per bucket file size limit. + * @param options.allowedMimeTypes specifies the allowed mime types that this bucket can accept during upload. + * The default value is null, which allows files with all mime types to be uploaded. + * Each mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png. */ async updateBucket( id: string,