Skip to content

Class YggdrasilClient

🏭 Constructors

constructor

ts
new YggdrasilClient(api: string, options: YggdrasilClientOptions): YggdrasilClient

Create client for official-like api endpoint

Parameters

  • api: string The official-like api endpoint
  • options: YggdrasilClientOptions

Return Type

  • YggdrasilClient

Defined in: packages/user/yggdrasil.ts:101

🏷️ Properties

api

ts
api: string

The official-like api endpoint

Defined in: packages/user/yggdrasil.ts:101

dispatcher

ts
dispatcher: Dispatcher

Defined in: packages/user/yggdrasil.ts:94

headers

ts
headers: Record<string, string>

Defined in: packages/user/yggdrasil.ts:95

🔧 Methods

invalidate

ts
invalidate(accessToken: string, clientToken: string, signal: AbortSignal): Promise<boolean>

Parameters

  • accessToken: string
  • clientToken: string
  • signal: AbortSignal

Return Type

  • Promise<boolean>

Defined in: packages/user/yggdrasil.ts:120

login

ts
login(__namedParameters: Object, signal: AbortSignal): Promise<YggrasilAuthentication>

Parameters

  • __namedParameters: Object
  • signal: AbortSignal

Return Type

  • Promise<YggrasilAuthentication>

Defined in: packages/user/yggdrasil.ts:133

refresh

ts
refresh(__namedParameters: Object, signal: AbortSignal): Promise<YggrasilAuthentication>

Parameters

  • __namedParameters: Object
  • signal: AbortSignal

Return Type

  • Promise<YggrasilAuthentication>

Defined in: packages/user/yggdrasil.ts:160

validate

ts
validate(accessToken: string, clientToken: string, signal: AbortSignal): Promise<boolean>

Parameters

  • accessToken: string
  • clientToken: string
  • signal: AbortSignal

Return Type

  • Promise<boolean>

Defined in: packages/user/yggdrasil.ts:106

Released under the MIT License.