FluxbaseStorage
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new FluxbaseStorage(
fetch):FluxbaseStorage
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
fetch |
FluxbaseFetch |
Returns
Section titled “Returns”FluxbaseStorage
Methods
Section titled “Methods”createBucket()
Section titled “createBucket()”createBucket(
bucketName):Promise<{data: {name:string; } |null;error:Error|null; }>
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<{ data: { name: string; } | null; error: Error | null; }>
deleteBucket()
Section titled “deleteBucket()”deleteBucket(
bucketName):Promise<{data: {message:string; } |null;error:Error|null; }>
Delete a bucket
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
bucketName |
string |
The name of the bucket to delete |
Returns
Section titled “Returns”Promise<{ data: { message: string; } | null; error: Error | null; }>
emptyBucket()
Section titled “emptyBucket()”emptyBucket(
bucketName):Promise<{data: {message:string; } |null;error:Error|null; }>
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<{ data: { message: string; } | null; error: Error | null; }>
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<{data:Bucket|null;error:Error|null; }>
Get bucket details
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
bucketName |
string |
The name of the bucket |
Returns
Section titled “Returns”Promise<{ data: Bucket | null; error: Error | null; }>
listBuckets()
Section titled “listBuckets()”listBuckets():
Promise<{data:object[] |null;error:Error|null; }>
List all buckets
Returns
Section titled “Returns”Promise<{ data: object[] | null; error: Error | null; }>
updateBucketSettings()
Section titled “updateBucketSettings()”updateBucketSettings(
bucketName,settings):Promise<{data:null;error:Error|null; }>
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<{ data: null; error: Error | null; }>