/id Client SDK

Modules

• Types

Classes

• SlashID
• User

Type Aliases

Factor

Ƭ Factor: FactorTypeHelper<FactorMethodOptionsTypeMap>[keyof FactorTypeHelper<FactorMethodOptionsTypeMap>]

---

FactorMethod

Ƭ FactorMethod: keyof FactorMethodOptionsTypeMap

---

PersonHandleType

Ƭ PersonHandleType: typeof PersonHandleType[keyof typeof PersonHandleType]

---

WebAuthnAuthenticatorAttachment

Ƭ WebAuthnAuthenticatorAttachment: typeof WebAuthnAuthenticatorAttachment[keyof typeof WebAuthnAuthenticatorAttachment]

Variables

Errors

• Const Errors: Object

Type declaration

Name	Type
InvalidAuthenticationMethodError	{ constructor: (method: FactorMethod, message: string) => InvalidAuthenticationMethodError }
RateLimitError	{ name: string = "RateLimitError"; response: Response ; fromResponseError: (responseError: ResponseError) => Promise<RateLimitError> }
isRateLimitError	(error: any) => error is RateLimitError
isResponseError	(error: any) => error is ResponseError

---

PersonHandleType

• Const PersonHandleType: Object

Export

Type declaration

Name	Type
EmailAddress	"email_address"
PhoneNumber	"phone_number"

---

SSR

• Const SSR: Object

Type declaration

Name	Type
User	typeof BaseUser

---

WebAuthnAuthenticatorAttachment

• Const WebAuthnAuthenticatorAttachment: Object

Export

Type declaration

Name	Type
Any	"any"
CrossPlatform	"cross_platform"
Platform	"platform"

---

errors

• Const errors: Object

Type declaration

Name	Type
InvalidAuthenticationMethodError	{ constructor: (method: FactorMethod, message: string) => InvalidAuthenticationMethodError }
RateLimitError	{ name: string = "RateLimitError"; response: Response ; fromResponseError: (responseError: ResponseError) => Promise<RateLimitError> }
isRateLimitError	(error: any) => error is RateLimitError
isResponseError	(error: any) => error is ResponseError

---

version

• Const version: Object

An object carrying the SlashID SDK version information

Type declaration

Name	Type
major	string
minor	string
patch	string
raw	string