Class RequestBuilder

Index

Constructors

constructor

new RequestBuilder(
client: JMAPClientInterface<RequestBuilder>,
__namedParameters: ClientContext,
): RequestBuilder
Parameters
- client: JMAPClientInterface<RequestBuilder>
- __namedParameters: ClientContext
Returns RequestBuilder
- Defined in src/request-builder/request-builder.ts:26

Accessors

createdIds

get createdIds(): Readonly<Record<string, string>> | null
Get the map of created IDs that are included in this request

Returns Readonly<Record<string, string>> | null
- Defined in src/request-builder/request-builder.ts:43

idMap

get idMap(): Map<symbol, Id>
Get the map of client-specified creation IDs to server-assigned IDs

Returns Map<symbol, Id>
- Defined in src/request-builder/request-builder.ts:48

methodCalls

get methodCalls(): readonly Invocation<BaseInvocationArgs>[]
Get the collection of method calls that are included in this request

Returns readonly Invocation<BaseInvocationArgs>[]
- Defined in src/request-builder/request-builder.ts:38

reverseIdMap

get reverseIdMap(): Map<Id, symbol>
Get the reverse map of server-assigned IDs to client-specified creation IDs

Returns Map<Id, symbol>
- Defined in src/request-builder/request-builder.ts:54

using

get using(): Set<keyof JMAPServerCapabilities>
Get the set of unique URIs that will be included in the using parameter of the JMAP request

Returns Set<keyof JMAPServerCapabilities>
- Defined in src/request-builder/request-builder.ts:32

Methods

add

add(method: Invocation<BaseInvocationArgs>): this
Add a method call to the request. All methods must be unique. If the method already exists in the request, it will not be added again.
Parameters
- method: Invocation<BaseInvocationArgs>
  The method call to add to the request
Returns this
The invocation builder instance to allow for method chaining

Throws
Error if the method's capability is not registered with the client

Throws
Error if adding this method would exceed the server's maxCallsInRequest limit

Throws
AggregateError if the invocation validation fails
- Defined in src/request-builder/request-builder.ts:69

addCreatedIds

addCreatedIds(createdIds: IdMap): this
Add the map of client specified creation IDs to server assigned IDs, to be included in the request.

This may be invoked with an empty object to initialise the createdIds for the first request, or with a map of client-specified creation IDs to the server-assigned IDs that were obtained from a previous response.
Parameters
- createdIds: IdMap
  The map of client-specified creation IDs to the server assigned IDs
Returns this
The invocation builder instance to allow for method chaining
- Defined in src/request-builder/request-builder.ts:129

build

build(idPrefix?: string): JMAPRequest
Build the JMAP request object from the current state of the builder.

This will generate unique IDs for each method call, and resolve any client-specified creation IDs to server-assigned IDs if they were provided.
Parameters
- idPrefix: string = ID_PREFIX
  The prefix to use for generated IDs (default is "id_")
Returns JMAPRequest
The constructed JMAP request object

Throws
AggregateError if the pre-build validation fails
- Defined in src/request-builder/request-builder.ts:165

clearCreatedIds

clearCreatedIds(): this
Reset the map of creation ids to remove any that had been previously added. After invoking this, the createdIds property will will be omitted from the request.

Returns this
- Defined in src/request-builder/request-builder.ts:146

remove

remove(method: Invocation<BaseInvocationArgs>): this
Remove a method call from the request. If the method does not exist in the request, this method will do nothing.
Parameters
- method: Invocation<BaseInvocationArgs>
  The method call to remove from the request
Returns this
The invocation builder instance to allow for method chaining
- Defined in src/request-builder/request-builder.ts:109

send

send(
    signal?: AbortSignal,
): Promise<
    {
        createdIds: IdMap;
        methodResponses: InvocationList<BaseInvocationArgs>;
        sessionState: string;
    },
>
Send this request to the JMAP server using the associated client.
Parameters
- Optionalsignal: AbortSignal
  Optional AbortSignal to cancel the request.
Returns Promise<
    {
        createdIds: IdMap;
        methodResponses: InvocationList<BaseInvocationArgs>;
        sessionState: string;
    },
>
The parsed response from the server.
- Defined in src/request-builder/request-builder.ts:258

serialize

serialize(): Promise<
    { body: string
    | Blob
    | ArrayBuffer
    | File; headers: Headers },
>
Serialise the request for sending as a request body. By default, returns a JSON string, but can be extended to support other formats.

Returns Promise<{ body: string | Blob | ArrayBuffer | File; headers: Headers }>
The serialised request (string, Blob, ArrayBuffer, etc.)

Throws
AggregateError if the pre-serialization validation fails

Throws
AggregateError if the post-serialization validation fails
- Defined in src/request-builder/request-builder.ts:200

toJSON

toJSON(): JMAPRequest
Returns JMAPRequest
- Defined in src/request-builder/request-builder.ts:265

validateInvocations

validateInvocations(): Promise<RequestBuilder>
Validate all invocations currently in the request.

Returns Promise<RequestBuilder>
A Promise resolving to the invocation builder instance

Throws
AggregateError if any invocation validation fails
- Defined in src/request-builder/request-builder.ts:275

Class RequestBuilder

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns RequestBuilder

Accessors

createdIds

Returns Readonly<Record<string, string>> | null

idMap

Returns Map<symbol, Id>

methodCalls

Returns readonly Invocation<BaseInvocationArgs>[]

reverseIdMap

Returns Map<Id, symbol>

using

Returns Set<keyof JMAPServerCapabilities>

Methods

add

Parameters

Returns this

Throws

Throws

Throws

addCreatedIds

Parameters

Returns this

build

Parameters

Returns JMAPRequest

Throws

clearCreatedIds

Returns this

remove

Parameters

Returns this

send

Parameters

Returns Promise< { createdIds: IdMap; methodResponses: InvocationList<BaseInvocationArgs>; sessionState: string; },>

serialize

Returns Promise<{ body: string | Blob | ArrayBuffer | File; headers: Headers }>

Throws

Throws

toJSON

Returns JMAPRequest

validateInvocations

Returns Promise<RequestBuilder>

Throws

Settings

On This Page

Returns Promise<
{
createdIds: IdMap;
methodResponses: InvocationList<BaseInvocationArgs>;
sessionState: string;
},
>