Class MeldbaseClient

Provides authenticated remote document operations, RPC calls, and shared realtime subscriptions.

Index

Constructors

constructor

new MeldbaseClient(options: ClientOptions): MeldbaseClient
Parameters
- options: ClientOptions
Returns MeldbaseClient
- Defined in sdk/client/src/remote/client.ts:50

Accessors

realtimeProtocol

get realtimeProtocol(): ProtocolDescriptor | undefined
Returns ProtocolDescriptor | undefined
- Defined in sdk/client/src/remote/client.ts:74

Methods

call

call<T extends Value = Value>(
    method: string,
    input: Value,
    options?: CallOptions,
): Promise<T>
Type Parameters
- T extends Value = Value
Parameters
- method: string
- input: Value
- options: CallOptions = {}
Returns Promise<T>
- Defined in sdk/client/src/remote/client.ts:78

close

close(): void
Returns void
- Defined in sdk/client/src/remote/client.ts:69

collection

collection<T extends Document = Document>(name: string): RemoteCollection<T>
Type Parameters
- T extends Document = Document
Parameters
- name: string
Returns RemoteCollection<T>
- Defined in sdk/client/src/remote/client.ts:64

count

count(
    collection: string,
    query: QuerySpec,
    signal?: AbortSignal,
): Promise<CountResult>
Parameters
- collection: string
- query: QuerySpec
- Optionalsignal: AbortSignal
Returns Promise<CountResult>
- Defined in sdk/client/src/remote/client.ts:175

executeMutation

executeMutation(
    collection: string,
    action: "updateOne" | "updateMany" | "deleteOne" | "deleteMany",
    query: QuerySpec,
    update?: MutationSpec,
    signal?: AbortSignal,
): Promise<MutationResult | DeleteResult>
Parameters
- collection: string
- action: "updateOne" | "updateMany" | "deleteOne" | "deleteMany"
- query: QuerySpec
- Optionalupdate: MutationSpec
- Optionalsignal: AbortSignal
Returns Promise<MutationResult | DeleteResult>
- Defined in sdk/client/src/remote/client.ts:274

fetchQuery

fetchQuery<T extends Document>(
    collection: string,
    query: QuerySpec,
    signal?: AbortSignal,
): Promise<T[]>
Type Parameters
- T extends Document
Parameters
- collection: string
- query: QuerySpec
- Optionalsignal: AbortSignal
Returns Promise<T[]>
- Defined in sdk/client/src/remote/client.ts:149

groupCount

groupCount(
    collection: string,
    query: QuerySpec,
    groupBy: string,
    signal?: AbortSignal,
): Promise<GroupCountResult>
Parameters
- collection: string
- query: QuerySpec
- groupBy: string
- Optionalsignal: AbortSignal
Returns Promise<GroupCountResult>
- Defined in sdk/client/src/remote/client.ts:197

insertOne

insertOne(
    collection: string,
    document: InputDocument,
    signal?: AbortSignal,
): Promise<Document>
Parameters
- collection: string
- document: InputDocument
- Optionalsignal: AbortSignal
Returns Promise<Document>
- Defined in sdk/client/src/remote/client.ts:234

subscribe(
    collection: string,
    query: QuerySpec,
    listener: SnapshotListener<Document>,
    options: SubscribeOptions,
): Unsubscribe
Parameters
- collection: string
- query: QuerySpec
- listener: SnapshotListener<Document>
- options: SubscribeOptions
Returns Unsubscribe
- Defined in sdk/client/src/remote/client.ts:332

Class MeldbaseClient

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns MeldbaseClient

Accessors

realtimeProtocol

Returns ProtocolDescriptor | undefined

Methods

call

Type Parameters

Parameters

Returns Promise<T>

close

Returns void

collection

Type Parameters

Parameters

Returns RemoteCollection<T>

count

Parameters

Returns Promise<CountResult>

executeMutation

Parameters

Returns Promise<MutationResult | DeleteResult>

fetchQuery

Type Parameters

Parameters

Returns Promise<T[]>

groupCount

Parameters

Returns Promise<GroupCountResult>

insertOne

Parameters

Returns Promise<Document>

subscribe

Parameters

Returns Unsubscribe

Settings

On This Page