Interface IObjectStoreBucket

The object store bucket interface.

interface IObjectStoreBucket {
    close(): void;
    get(path: string, options?: IFileOptions): Promise<IFile>;
    getName(): string;
    getOwnerId(): string;
    getSize(path?: string): Promise<number>;
    list(path: string, options?: IObjectStoreListOptions): Promise<ObjectDescriptor[]>;
    publish(payload: Payload): Promise<void>;
    subscribe(label: string, callback: ((data: StorageEvent) => void)): void;
    unpublish(path: string): Promise<void>;
    unsubscribe(label: string): void;
}

Hierarchy (view full)

IDataStream
- IObjectStoreBucket

Index

Methods

close get getName getOwnerId getSize list publish subscribe unpublish unsubscribe

Methods

close

close(): void
Close the bucket.

Returns void

get

get(path, options?): Promise<IFile>
Get an object from the bucket.
Parameters
- path: string
  The path of the object.
- Optionaloptions: IFileOptions
  The optional options for getting the object.
Returns Promise<IFile>
The object.

getName

getName(): string
Get the name of the bucket.

Returns string
Overrides IDataStream.getName

getOwnerId

getOwnerId(): string
Get the owner ID of the bucket.

Returns string
Overrides IDataStream.getOwnerId

getSize

getSize(path?): Promise<number>
Get the storage size of the bucket.
Parameters
- Optionalpath: string
  Optionnally takes a path to get the size of a specific object or folder.
Returns Promise<number>
The storage size.

list

list(path, options?): Promise<ObjectDescriptor[]>
List the objects and folders of the bucket.
Parameters
- path: string
  The path of the folder.
- Optionaloptions: IObjectStoreListOptions
  The optional options for listing the objects and folders.
Returns Promise<ObjectDescriptor[]>
The list of objects and folders.

publish

publish(payload): Promise<void>
Publish an action to the bucket.
Parameters
- payload: Payload
  The object store payload.
Returns Promise<void>
A promise that resolves when the action is published.

subscribe

subscribe(label, callback): void
Subscribe to the bucket events.
Parameters
- label: string
  The label of the subscriber.
- callback: ((data: StorageEvent) => void)
  The callback function.
  - - (data): void
    - Parameters
      data: StorageEvent
      Returns void
Returns void

unpublish

unpublish(path): Promise<void>
Unpublish an object from the bucket. It also permanently deletes the object.
Parameters
- path: string
  The path of the object.
Returns Promise<void>
A promise that resolves when the object is unpublished.

unsubscribe

unsubscribe(label): void
Unsubscribe from the bucket.
Parameters
- label: string
  The label of the subscriber.
Returns void