Class YggdrasilClient

🏭 Constructors

constructor

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:106

🏷️ Properties

api public

api: string

The official-like api endpoint

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

fetch protected

fetch: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>

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

File protected

File: (fileBits: BlobPart[], fileName: string, options?: FilePropertyBag) => File

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

FormData protected

FormData: (form?: HTMLFormElement, submitter?: null | HTMLElement) => FormData

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

headers protected

headers: Record<string, string>

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

🔧 Methods

invalidate

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:126

login

login(__namedParameters: { clientToken: string; password: string; requestUser?: boolean; username: string }, signal: AbortSignal): Promise<YggrasilAuthentication>

Parameters

• __namedParameters: { clientToken: string; password: string; requestUser?: boolean; username: string }
• signal: AbortSignal

Return Type

• Promise<YggrasilAuthentication>

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

refresh

refresh(__namedParameters: { accessToken: string; clientToken: string; requestUser?: boolean }, signal: AbortSignal): Promise<YggrasilAuthentication>

Parameters

• __namedParameters: { accessToken: string; clientToken: string; requestUser?: boolean }
• signal: AbortSignal

Return Type

• Promise<YggrasilAuthentication>

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

validate

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:113