Class RestClient

Index

Accessors

csrfToken hasSession

Constructors

Methods

setTokens clearSession ensureCsrf refresh get post put patch delete request putAbsolute

Properties

baseUrl jar limiter userAgent timeoutMs maxRetries accessToken? refreshToken?

Accessors

csrfToken

get csrfToken(): string | undefined
Returns string | undefined
- Defined in src/rest.ts:60

hasSession

get hasSession(): boolean
Returns boolean
- Defined in src/rest.ts:64

Constructors

constructor

new RestClient(options?: RestClientOptions): RestClient
Parameters
- options: RestClientOptions = {}
Returns RestClient
- Defined in src/rest.ts:50

Methods

setTokens

setTokens(
    tokens: {
        accessToken?: string;
        refreshToken?: string;
        csrfToken?: string;
    },
): void
Parameters
- tokens: { accessToken?: string; refreshToken?: string; csrfToken?: string }
Returns void
- Defined in src/rest.ts:72

clearSession

clearSession(): void
Returns void
- Defined in src/rest.ts:100

ensureCsrf

ensureCsrf(force?: boolean): Promise<string | undefined>
Some endpoints return the CSRF cookie only on a 401. Fetch one early so the first mutating request does not fail.
Parameters
- force: boolean = false
Returns Promise<string | undefined>
- Defined in src/rest.ts:112

refresh

refresh(): Promise<boolean>
Refreshes the access token using the refresh-token cookie.

Returns Promise<boolean>
- Defined in src/rest.ts:133

get

get<T>(path: string, options?: RequestOptions): Promise<T>
Type Parameters
- T
Parameters
- path: string
- options: RequestOptions = {}
Returns Promise<T>
- Defined in src/rest.ts:171

post

post<T>(path: string, options?: RequestOptions): Promise<T>
Type Parameters
- T
Parameters
- path: string
- options: RequestOptions = {}
Returns Promise<T>
- Defined in src/rest.ts:175

put

put<T>(path: string, options?: RequestOptions): Promise<T>
Type Parameters
- T
Parameters
- path: string
- options: RequestOptions = {}
Returns Promise<T>
- Defined in src/rest.ts:179

patch

patch<T>(path: string, options?: RequestOptions): Promise<T>
Type Parameters
- T
Parameters
- path: string
- options: RequestOptions = {}
Returns Promise<T>
- Defined in src/rest.ts:183

delete

delete<T>(path: string, options?: RequestOptions): Promise<T>
Type Parameters
- T
Parameters
- path: string
- options: RequestOptions = {}
Returns Promise<T>
- Defined in src/rest.ts:187

request

request<T = unknown>(
    method: HttpMethod,
    path: string,
    options?: RequestOptions,
): Promise<T>
Type Parameters
- T = unknown
Parameters
- method: HttpMethod
- path: string
- options: RequestOptions = {}
Returns Promise<T>
- Defined in src/rest.ts:191

putAbsolute

putAbsolute(url: string, body: BodyInit, timeoutMs?: number): Promise<string>
PUT a raw body to an absolute (usually presigned) URL, returning the ETag.
Parameters
- url: string
- body: BodyInit
- timeoutMs: number = ...
Returns Promise<string>
- Defined in src/rest.ts:253

Properties

`Readonly`baseUrl

baseUrl: string

`Readonly`jar

`Readonly`limiter

limiter: RateLimiter

`Readonly`userAgent

userAgent: string

`Readonly`timeoutMs

timeoutMs: number

`Readonly`maxRetries

maxRetries: number

`Optional`accessToken

accessToken?: string

`Optional`refreshToken

refreshToken?: string