Class Dispatch

API communication class

Index

Properties

Methods

getEndpoint login logout

Properties

`Static` `Readonly`i

i: Dispatch = ...

Singleton instance.

`Static` `Optional`token

token?: string

Token used for authentication on the server side. Allows access to deleted revisions if the user has proper rights.

Methods

getEndpoint

getEndpoint(endpoint): Promise<URL>
Returns a fully-formed HTTP URL from a given endpoint. This uses the wiki's set Dispatch endpoint and a given target (such as /v1/revisions) to get the full URL.
Parameters
- endpoint: string
  The endpoint to get
Returns Promise<URL>
- Defined in src/api/Dispatch.ts:49

login

login(): Promise<void>
Logs in the user. Optional: only used for getting data on deleted revisions.

Returns Promise<void>
- Defined in src/api/Dispatch.ts:35

logout

logout(): Promise<void>
Logs the user out of the API.

Returns Promise<void>
- Defined in src/api/Dispatch.ts:27