Skip to content

chore: hide indexedDB from storageState() and BrowserContext option #35058

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 6, 2025
Merged

chore: hide indexedDB from storageState() and BrowserContext option #35058

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2324e6d
chore: hide storageState from storageState() and BrowserContext option
mxschmitt Mar 5, 2025
8066e9d
fix tests
mxschmitt Mar 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/src/api/class-apirequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,6 @@ Methods like [`method: APIRequestContext.get`] take the base URL into considerat
- `localStorage` <[Array]<[Object]>>
- `name` <[string]>
- `value` <[string]>
- `indexedDB` ?<[Array]<[unknown]>> indexedDB to set for context

Populates context with given storage state. This option can be used to initialize context with logged-in information
obtained via [`method: BrowserContext.storageState`] or [`method: APIRequestContext.storageState`]. Either a path to the
Expand Down
1 change: 0 additions & 1 deletion docs/src/api/class-apirequestcontext.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -880,7 +880,6 @@ context cookies from the response. The method will automatically follow redirect
- `localStorage` <[Array]<[Object]>>
- `name` <[string]>
- `value` <[string]>
- `indexedDB` <[Array]<[unknown]>>

Returns storage state for this request context, contains current cookies and local storage snapshot if it was passed to the constructor.

Expand Down
1 change: 0 additions & 1 deletion docs/src/api/class-browsercontext.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1509,7 +1509,6 @@ Whether to emulate network being offline for the browser context.
- `localStorage` <[Array]<[Object]>>
- `name` <[string]>
- `value` <[string]>
- `indexedDB` <[Array]<[unknown]>>

Returns storage state for this browser context, contains current cookies, local storage snapshot and IndexedDB snapshot.

Expand Down
1 change: 0 additions & 1 deletion docs/src/api/params.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,6 @@ Specify environment variables that will be visible to the browser. Defaults to `
- `localStorage` <[Array]<[Object]>> localStorage to set for context
- `name` <[string]>
- `value` <[string]>
- `indexedDB` ?<[Array]<[unknown]>> indexedDB to set for context

Learn more about [storage state and auth](../auth.md).

Expand Down
19 changes: 0 additions & 19 deletions packages/playwright-client/types/types.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9317,8 +9317,6 @@ export interface BrowserContext {

value: string;
}>;

indexedDB: Array<unknown>;
}>;
}>;

Expand Down Expand Up @@ -10085,11 +10083,6 @@ export interface Browser {

value: string;
}>;

/**
* indexedDB to set for context
*/
indexedDB?: Array<unknown>;
}>;
};

Expand Down Expand Up @@ -17638,11 +17631,6 @@ export interface APIRequest {

value: string;
}>;

/**
* indexedDB to set for context
*/
indexedDB?: Array<unknown>;
}>;
};

Expand Down Expand Up @@ -18457,8 +18445,6 @@ export interface APIRequestContext {

value: string;
}>;

indexedDB: Array<unknown>;
}>;
}>;

Expand Down Expand Up @@ -22306,11 +22292,6 @@ export interface BrowserContextOptions {

value: string;
}>;

/**
* indexedDB to set for context
*/
indexedDB?: Array<unknown>;
}>;
};

Expand Down
2 changes: 1 addition & 1 deletion packages/playwright-core/src/client/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export type SelectOptionOptions = { force?: boolean, timeout?: number };
export type FilePayload = { name: string, mimeType: string, buffer: Buffer };
export type StorageState = {
cookies: channels.NetworkCookie[],
origins: (Omit<channels.OriginStorage, 'indexedDB'> & { indexedDB: unknown[] })[],
origins: (Omit<channels.OriginStorage, 'indexedDB'>)[],
};
export type SetStorageState = {
cookies?: channels.SetNetworkCookie[],
Expand Down
19 changes: 0 additions & 19 deletions packages/playwright-core/types/types.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9317,8 +9317,6 @@ export interface BrowserContext {

value: string;
}>;

indexedDB: Array<unknown>;
}>;
}>;

Expand Down Expand Up @@ -10085,11 +10083,6 @@ export interface Browser {

value: string;
}>;

/**
* indexedDB to set for context
*/
indexedDB?: Array<unknown>;
}>;
};

Expand Down Expand Up @@ -17638,11 +17631,6 @@ export interface APIRequest {

value: string;
}>;

/**
* indexedDB to set for context
*/
indexedDB?: Array<unknown>;
}>;
};

Expand Down Expand Up @@ -18457,8 +18445,6 @@ export interface APIRequestContext {

value: string;
}>;

indexedDB: Array<unknown>;
}>;
}>;

Expand Down Expand Up @@ -22306,11 +22292,6 @@ export interface BrowserContextOptions {

value: string;
}>;

/**
* indexedDB to set for context
*/
indexedDB?: Array<unknown>;
}>;
};

Expand Down
Loading