Class CollectionsAPI`Internal`

The class that encapsulates the collections API

Index

Constructors

Methods

create drop list

Constructors

constructor

new CollectionsAPI(api: API): CollectionsAPI
Parameters
- api: API
Returns CollectionsAPI
- Defined in sdk/src/api/collections.ts:10

Methods

create

create(collectionName: string): Promise<BazaarMessage>
Creates a collection.
Parameters
- collectionName: string
Returns Promise<BazaarMessage>
- Defined in sdk/src/api/collections.ts:17

drop

drop(collectionName: string): Promise<BazaarMessage>
Drops a collection.
Parameters
- collectionName: string
Returns Promise<BazaarMessage>
- Defined in sdk/src/api/collections.ts:24

list

list(): Promise<string[]>
Lists all collection names.

Returns Promise<string[]>
Where data is an array of collection names
- Defined in sdk/src/api/collections.ts:32