Interface IObjectStoreBucket

The object store bucket interface.

interface IObjectStoreBucket {
    close(): void;
    get(path): Promise<File>;
    getName(): string;
    getOwnerId(): string;
    list(path, recursive?): Promise<ObjectDescriptor[]>;
    publish(payload): Promise<void>;
    subscribe(callback): void;
    unpublish(path): Promise<void>;
    unsubscribe(): void;
}

Hierarchy (view full)

IDataStream
- IObjectStoreBucket

Index

Methods

close get getName getOwnerId list publish subscribe unpublish unsubscribe

Methods

close

close(): void
Close the bucket.

Returns void

get

get(path): Promise<File>
Get an object from the bucket.
Parameters
- path: string
  The path of the object.
Returns Promise<File>
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

list

list(path, recursive?): Promise<ObjectDescriptor[]>
List the objects and folders of the bucket.
Parameters
- path: string
  The path of the folder.
- Optional recursive: boolean
  Whether to list the objects and folders recursively.
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(callback): void
Subscribe to the bucket events.
Parameters
- callback: ((data) => 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(): void
Unsubscribe from the bucket.

Returns void

Generated using TypeDoc