AuthStorage interface

Storage interface used by Auth to persist the session (and PKCE state) across page loads. Defaults to window.localStorage; provide a custom implementation (or false for memory-only) via the Auth constructor options.

Method Details

clear()

function clear(): void | Promise<void>

Returns

void | Promise<void>

getItem(string)

function getItem(key: string): string | Promise<string | null> | null

Parameters

key

string

Returns

string | Promise<string | null> | null

keys(string)

function keys(prefix: string): string[] | Promise<string[]>

Parameters

prefix

string

Returns

string[] | Promise<string[]>

removeItem(string)

function removeItem(key: string): void | Promise<void>

Parameters

key

string

Returns

void | Promise<void>

setItem(string, string)

function setItem(key: string, value: string): void | Promise<void>

Parameters

key

string

value

string

Returns

void | Promise<void>