MantleClient
Defined in: client.ts:26
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new MantleClient(
options):MantleClient
Defined in: client.ts:41
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”MantleClient
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get url():
string
Defined in: client.ts:104
The server’s base URL, trailing slashes removed — handy for building links to non-service routes.
Returns
Section titled “Returns”string
Methods
Section titled “Methods”authenticate()
Section titled “authenticate()”authenticate(
credentials):Promise<AuthResult>
Defined in: client.ts:67
Parameters
Section titled “Parameters”credentials
Section titled “credentials”Returns
Section titled “Returns”Promise<AuthResult>
getAccessToken()
Section titled “getAccessToken()”getAccessToken():
string|undefined
Defined in: client.ts:108
Returns
Section titled “Returns”string | undefined
isAuthenticated()
Section titled “isAuthenticated()”isAuthenticated():
Promise<boolean>
Defined in: client.ts:120
Whether a persisted session exists, hydrating the in-memory access token from storage first
if nothing has triggered that yet. Use this on app startup instead of getAccessToken() —
that one is synchronous and returns undefined until hydration has happened (normally the
side effect of an authenticated REST call), even when a valid token is sitting in storage
from a previous session. A UI that checks getAccessToken() on first render will show its
logged-out state on every page load/refresh regardless of a persisted session.
Returns
Section titled “Returns”Promise<boolean>
logout()
Section titled “logout()”logout():
Promise<void>
Defined in: client.ts:92
Returns
Section titled “Returns”Promise<void>
off(
event,handler):this
Defined in: client.ts:129
Parameters
Section titled “Parameters”handler
Section titled “handler”() => void
Returns
Section titled “Returns”this
on(
event,handler):this
Defined in: client.ts:124
Parameters
Section titled “Parameters”handler
Section titled “handler”() => void
Returns
Section titled “Returns”this
request()
Section titled “request()”request<
R>(method,path,data,params?):Promise<R>
Defined in: client.ts:135
REST dispatch used by every ServiceClient method: bearer auth, one refresh-retry on 401, typed errors.
Type Parameters
Section titled “Type Parameters”R
Parameters
Section titled “Parameters”method
Section titled “method”string
string
unknown
params?
Section titled “params?”Returns
Section titled “Returns”Promise<R>
service()
Section titled “service()”service<
T>(path):ServiceClient<T>
Defined in: client.ts:57
Type Parameters
Section titled “Type Parameters”T = unknown
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”setTokens()
Section titled “setTokens()”setTokens(
tokens):Promise<void>
Defined in: client.ts:86
Hydrate the client from a token pair obtained outside authenticate() — e.g. an OAuth
provider’s redirect-back callback landing tokens in the URL fragment. Stores them and
emits 'authenticated', same as a successful authenticate() call.
Parameters
Section titled “Parameters”tokens
Section titled “tokens”accessToken
Section titled “accessToken”string
refreshToken?
Section titled “refreshToken?”string
Returns
Section titled “Returns”Promise<void>
upload()
Section titled “upload()”upload<
R>(method,path,body,options?):Promise<R>
Defined in: client.ts:152
multipart/form-data dispatch used by ServiceClient.upload(): bearer auth, one refresh-retry
on 401, typed errors — the same guarantees as request(). The body is rebuilt for the retry,
since a consumed FormData stream can’t be replayed by every transport.
Type Parameters
Section titled “Type Parameters”R
Parameters
Section titled “Parameters”method
Section titled “method”string
string
() => FormData
options?
Section titled “options?”Returns
Section titled “Returns”Promise<R>