Interface Extension<Req, Res>

An interface that must be satisfied to register extensions

interface Extension<Req extends object, Res extends object> {
    name(): string;
    onRequest(isInitial: boolean): undefined | Req;
    onResponse(data: Res): Promise<void>;
    when(): ExtensionState;
}

Type Parameters

Req extends object
Res extends object

Index

Methods

name onRequest onResponse when

Methods

name

name(): string
The extension name to go under 'extensions' in the request body.

Returns string
The JSON key.
- Defined in src/sliding-sync.ts:273

onRequest

onRequest(isInitial: boolean): undefined | Req
A function which is called when the request JSON is being formed. Returns the data to insert under this key.
Parameters
- isInitial: boolean
  True when this is part of the initial request (send sticky params)
Returns undefined | Req
The request JSON to send.
- Defined in src/sliding-sync.ts:280

onResponse

onResponse(data: Res): Promise<void>
A function which is called when there is response JSON under this extension.
Parameters
- data: Res
  The response JSON under the extension name.
Returns Promise<void>
- Defined in src/sliding-sync.ts:285

when

when(): ExtensionState
Controls when onResponse should be called.

Returns ExtensionState
The state when it should be called.
- Defined in src/sliding-sync.ts:290