API Reference

---

API Reference / TokenResponse

Class: TokenResponse

Defined in: src/auth/TokenResponse.ts:26

A parsed access token with its expiry.

Wraps the raw payload so expiry handling lives in one place rather than being re-derived by every caller that needs to know whether a token is still good.

Constructors

Constructor

new TokenResponse(raw): TokenResponse

Defined in: src/auth/TokenResponse.ts:36

Parameters

raw

RawTokenResponse

Returns

TokenResponse

Properties

accessToken

readonly accessToken: string

Defined in: src/auth/TokenResponse.ts:27

---

clientId?

readonly optional clientId?: string

Defined in: src/auth/TokenResponse.ts:28

---

clientName?

readonly optional clientName?: string

Defined in: src/auth/TokenResponse.ts:29

---

ucc?

readonly optional ucc?: string

Defined in: src/auth/TokenResponse.ts:30

---

powerOfAttorney?

readonly optional powerOfAttorney?: boolean

Defined in: src/auth/TokenResponse.ts:31

---

expiresAt?

readonly optional expiresAt?: number

Defined in: src/auth/TokenResponse.ts:33

Epoch milliseconds, or undefined when the response carried no expiry.

---

raw

readonly raw: RawTokenResponse

Defined in: src/auth/TokenResponse.ts:34

Methods

isExpired()

isExpired(now?): boolean

Defined in: src/auth/TokenResponse.ts:57

True when the token is past its expiry. A response with no expiry is treated as expired, so an unparseable payload fails closed rather than being trusted indefinitely.

Parameters

now?

number = ...

Returns

boolean

---

expiresIn()

expiresIn(now?): number

Defined in: src/auth/TokenResponse.ts:62

Milliseconds until expiry, floored at 0.

Parameters

now?

number = ...

Returns

number

---

needsRefresh()

needsRefresh(bufferMs?, now?): boolean

Defined in: src/auth/TokenResponse.ts:71

True once the token is inside bufferMs of expiring.

Parameters

bufferMs?

number = DEFAULT_REFRESH_BUFFER_MS

now?

number = ...

Returns

boolean