Interface WebStorage

WebStorage exposes the page's localStorage or sessionStorage for the current origin via an async, browser-consistent API.

Instances are accessed through page.localStorage and page.sessionStorage.

await page.goto('https://example.com');
await page.localStorage.setItem('token', 'abc');
const token = await page.localStorage.getItem('token');
const all = await page.localStorage.items();
await page.localStorage.removeItem('token');
await page.localStorage.clear();
interface WebStorage {
    clear(): Promise<void>;
    getItem(name): Promise<string>;
    items(): Promise<{
        name: string;
        value: string;
    }[]>;
    removeItem(name): Promise<void>;
    setItem(name, value): Promise<void>;
}

Methods

clear getItem items removeItem setItem

Methods

clear

  • clear(): Promise<void>

  • Removes all items from the storage.

    Returns Promise<void>

getItem

  • getItem(name): Promise<string>

  • Returns the value for the given name if present.

    Parameters

    • name: string

      Name of the item to retrieve.

    Returns Promise<string>

items

  • items(): Promise<{
        name: string;
        value: string;
    }[]>

  • Returns all items in the storage as name/value pairs.

    Returns Promise<{
        name: string;
        value: string;
    }[]>

removeItem

  • removeItem(name): Promise<void>

  • Removes the item with the given name. No-op if the item is absent.

    Parameters

    • name: string

      Name of the item to remove.

    Returns Promise<void>

setItem

  • setItem(name, value): Promise<void>

  • Sets the value for the given name. Overwrites any existing value for that name.

    Parameters

    • name: string

      Name of the item to set.

    • value: string

      New value for the item.

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

cleargetItemitemsremoveItemsetItem