`Client`

The Client object keeps track of the authenticated sessions in the current device. The device can be a browser, a native application or any other medium that is usually the requesting part in a request/response architecture.

The Client object also holds information about any sign in or sign up attempts that might be in progress, tracking the sign in or sign up progress.

Properties

Name	Type	Description
`signIn`	`SignIn` \| `null`	The current sign in attempt, or `null` if there is none.
`signUp`	`SignUp` \| `null`	The current sign up attempt, or `null` if there is none.
`sessions`	`Session[]`	A list of sessions that have been created on this client.
`activeSessions`	`Session[]`	A list of active sessions on this client.
`lastActiveSessionId`	`string`	Unique identifier of the last active `Session` on this client.
`updatedAt`	`Date`	Timestamp of last update for the client.

Methods

`isNew()`

Returns true if this client hasn't been saved (created) yet in the Frontend API. Returns false otherwise.


function isNew(): boolean;

`create()`

Creates a new client for the current instance along with its cookie.


function create(): Promise<Client>;

`destroy()`

Deletes the client. All sessions will be reset.


function destroy(): Promise<void>;

Last updated on April 19, 2024