Class CollectionsAPI`Internal`

The class that encapsulates the collections API

Index

Constructors

Properties

api contextOptions

Methods

create drop list

Constructors

constructor

new CollectionsAPI(api, contextOptions?): CollectionsAPI
Parameters
- api: API
- contextOptions: ContextOptions = {}
Returns CollectionsAPI
- Defined in src/api/collections.ts:12

Properties

`Private` api

api: API

`Private` contextOptions

contextOptions: ContextOptions

Methods

create

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

drop

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

list

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

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