Class CollectionAPI<T>`Internal`

Type Parameters

T extends Doc = AnyDoc

Index

Constructors

constructor

Methods

deleteAll deleteOne getAll getOne getPage insertOne replaceOne subscribeAll subscribeOne updateOne

Constructors

constructor

new CollectionAPI<
    T extends
        Doc = {
        id: string;
        [key: string]: unknown;
        [key: number]: unknown;
        [key: symbol]: unknown;
    },
>(
    api: API,
    collectionName: string,
    collectionOptions?: CollectionOptions,
): CollectionAPI<T>
Type Parameters
- T extends Doc = {
      id: string;
      [key: string]: unknown;
      [key: number]: unknown;
      [key: symbol]: unknown;
  }
Parameters
- api: API
- collectionName: string
- collectionOptions: CollectionOptions = {}
Returns CollectionAPI<T>
- Defined in sdk/src/api/collection.ts:21

Methods

deleteAll

deleteAll(filter?: FilterObject): Promise<BazaarMessage>
Parameters
- filter: FilterObject = {}
Returns Promise<BazaarMessage>
- Defined in sdk/src/api/collection.ts:133

deleteOne

deleteOne(docId: string): Promise<BazaarMessage>
Parameters
- docId: string
Returns Promise<BazaarMessage>
- Defined in sdk/src/api/collection.ts:127

getAll

getAll(
filter?: FilterObject,
options?: { endOffset?: number; orderBy?: OrderBy; startOffset?: number },
): Promise<T[]>
Parameters
- filter: FilterObject = {}
- options: { endOffset?: number; orderBy?: OrderBy; startOffset?: number } = {}
Returns Promise<T[]>
- Defined in sdk/src/api/collection.ts:41

getOne

getOne(docId: string): Promise<T | null>
Parameters
- docId: string
Returns Promise<T | null>
- Defined in sdk/src/api/collection.ts:31

getPage

getPage(
    pageNumber: number,
    pageSize: number,
    filter?: FilterObject,
    options?: { orderBy?: OrderBy },
): Promise<T[]>
Parameters
- pageNumber: number
- pageSize: number
- filter: FilterObject = {}
- options: { orderBy?: OrderBy } = {}
Returns Promise<T[]>
- Defined in sdk/src/api/collection.ts:58

insertOne

insertOne(doc: T | Omit<T, "id">): Promise<string>
Parameters
- doc: T | Omit<T, "id">
Returns Promise<string>
The doc ID
- Defined in sdk/src/api/collection.ts:108

replaceOne

replaceOne(docId: string, doc: T | Omit<T, "id">): Promise<BazaarMessage>
Parameters
- docId: string
- doc: T | Omit<T, "id">
Returns Promise<BazaarMessage>
- Defined in sdk/src/api/collection.ts:121

subscribeAll

subscribeAll(
filter: FilterObject,
listener: SubscribeListener<T>,
): Promise<() => Promise<string>>
Parameters
- filter: FilterObject
- listener: SubscribeListener<T>
Returns Promise<() => Promise<string>>
An unsubscribe function
- Defined in sdk/src/api/collection.ts:89

subscribeOne

subscribeOne(
docId: string,
listener: SubscribeListener<T>,
): Promise<() => Promise<string>>
Parameters
- docId: string
- listener: SubscribeListener<T>
Returns Promise<() => Promise<string>>
An unsubscribe function
- Defined in sdk/src/api/collection.ts:74

updateOne

updateOne(docId: string, doc: DeepPartial<T>): Promise<BazaarMessage>
Parameters
- docId: string
- doc: DeepPartial<T>
Returns Promise<BazaarMessage>
- Defined in sdk/src/api/collection.ts:115

Class CollectionAPI<T>Internal

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns CollectionAPI<T>

Methods

deleteAll

Parameters

Returns Promise<BazaarMessage>

deleteOne

Parameters

Returns Promise<BazaarMessage>

getAll

Parameters

Returns Promise<T[]>

getOne

Parameters

Returns Promise<T | null>

getPage

Parameters

Returns Promise<T[]>

insertOne

Parameters

Returns Promise<string>

replaceOne

Parameters

Returns Promise<BazaarMessage>

subscribeAll

Parameters

Returns Promise<() => Promise<string>>

subscribeOne

Parameters

Returns Promise<() => Promise<string>>

updateOne

Parameters

Returns Promise<BazaarMessage>

Settings

On This Page

Class CollectionAPI<T>`Internal`