FluxbaseStorage
Constructors
Section titled “Constructors”new FluxbaseStorage()
Section titled “new FluxbaseStorage()”new FluxbaseStorage(
fetch):FluxbaseStorage
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
fetch | FluxbaseFetch |
Returns
Section titled “Returns”Methods
Section titled “Methods”createBucket()
Section titled “createBucket()”createBucket(
bucketName):Promise<object>
Create a new bucket
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
bucketName | string | The name of the bucket to create |
Returns
Section titled “Returns”Promise<object>
| Name | Type |
|---|---|
data | null | object |
error | null | Error |
deleteBucket()
Section titled “deleteBucket()”deleteBucket(
bucketName):Promise<object>
Delete a bucket
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
bucketName | string | The name of the bucket to delete |
Returns
Section titled “Returns”Promise<object>
| Name | Type |
|---|---|
data | null | object |
error | null | Error |
emptyBucket()
Section titled “emptyBucket()”emptyBucket(
bucketName):Promise<object>
Empty a bucket (delete all files)
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
bucketName | string | The name of the bucket to empty |
Returns
Section titled “Returns”Promise<object>
| Name | Type |
|---|---|
data | null | object |
error | null | Error |
from()
Section titled “from()”from(
bucketName):StorageBucket
Get a reference to a storage bucket
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
bucketName | string | The name of the bucket |
Returns
Section titled “Returns”getBucket()
Section titled “getBucket()”getBucket(
bucketName):Promise<object>
Get bucket details
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
bucketName | string | The name of the bucket |
Returns
Section titled “Returns”Promise<object>
| Name | Type |
|---|---|
data | null | Bucket |
error | null | Error |
listBuckets()
Section titled “listBuckets()”listBuckets():
Promise<object>
List all buckets
Returns
Section titled “Returns”Promise<object>
| Name | Type |
|---|---|
data | null | object[] |
error | null | Error |
updateBucketSettings()
Section titled “updateBucketSettings()”updateBucketSettings(
bucketName,settings):Promise<object>
Update bucket settings (RLS - requires admin or service key)
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
bucketName | string | The name of the bucket |
settings | BucketSettings | Bucket settings to update |
Returns
Section titled “Returns”Promise<object>
| Name | Type |
|---|---|
data | null |
error | null | Error |