Skip to content

Commit a1f4cb8

Browse files
committed
more docs
1 parent f4dcfd6 commit a1f4cb8

File tree

4 files changed

+46
-0
lines changed

4 files changed

+46
-0
lines changed

docs/src/api/class-apirequest.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,9 @@ Methods like [`method: APIRequestContext.get`] take the base URL into considerat
8080
- `multiEntry` <[boolean]>
8181
- `records` <[Array]<[Object]>>
8282
- `key` ?<[Object]>
83+
- `keyEncoded` ?<[Object]> if `key` is not JSON-serializable, this contains an encoded version that preserves types.
8384
- `value` <[Object]>
85+
- `valueEncoded` ?<[Object]> if `value` is not JSON-serializable, this contains an encoded version that preserves types.
8486

8587
Populates context with given storage state. This option can be used to initialize context with logged-in information
8688
obtained via [`method: BrowserContext.storageState`] or [`method: APIRequestContext.storageState`]. Either a path to the

docs/src/api/class-apirequestcontext.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -896,7 +896,9 @@ context cookies from the response. The method will automatically follow redirect
896896
- `multiEntry` <[boolean]>
897897
- `records` <[Array]<[Object]>>
898898
- `key` ?<[Object]>
899+
- `keyEncoded` ?<[Object]> if `key` is not JSON-serializable, this contains an encoded version that preserves types.
899900
- `value` <[Object]>
901+
- `valueEncoded` ?<[Object]> if `value` is not JSON-serializable, this contains an encoded version that preserves types.
900902

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

docs/src/api/params.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,9 @@ Specify environment variables that will be visible to the browser. Defaults to `
280280
- `multiEntry` <[boolean]>
281281
- `records` <[Array]<[Object]>>
282282
- `key` ?<[Object]>
283+
- `keyEncoded` ?<[Object]> if `key` is not JSON-serializable, this contains an encoded version that preserves types.
283284
- `value` <[Object]>
285+
- `valueEncoded` ?<[Object]> if `value` is not JSON-serializable, this contains an encoded version that preserves types.
284286

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

packages/playwright-core/types/types.d.ts

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10157,7 +10157,17 @@ export interface Browser {
1015710157
records: Array<{
1015810158
key?: Object;
1015910159

10160+
/**
10161+
* if `key` is not JSON-serializable, this contains an encoded version that preserves types.
10162+
*/
10163+
keyEncoded?: Object;
10164+
1016010165
value: Object;
10166+
10167+
/**
10168+
* if `value` is not JSON-serializable, this contains an encoded version that preserves types.
10169+
*/
10170+
valueEncoded?: Object;
1016110171
}>;
1016210172
}>;
1016310173
}>;
@@ -17735,7 +17745,17 @@ export interface APIRequest {
1773517745
records: Array<{
1773617746
key?: Object;
1773717747

17748+
/**
17749+
* if `key` is not JSON-serializable, this contains an encoded version that preserves types.
17750+
*/
17751+
keyEncoded?: Object;
17752+
1773817753
value: Object;
17754+
17755+
/**
17756+
* if `value` is not JSON-serializable, this contains an encoded version that preserves types.
17757+
*/
17758+
valueEncoded?: Object;
1773917759
}>;
1774017760
}>;
1774117761
}>;
@@ -18578,7 +18598,17 @@ export interface APIRequestContext {
1857818598
records: Array<{
1857918599
key?: Object;
1858018600

18601+
/**
18602+
* if `key` is not JSON-serializable, this contains an encoded version that preserves types.
18603+
*/
18604+
keyEncoded?: Object;
18605+
1858118606
value: Object;
18607+
18608+
/**
18609+
* if `value` is not JSON-serializable, this contains an encoded version that preserves types.
18610+
*/
18611+
valueEncoded?: Object;
1858218612
}>;
1858318613
}>;
1858418614
}>;
@@ -22464,7 +22494,17 @@ export interface BrowserContextOptions {
2246422494
records: Array<{
2246522495
key?: Object;
2246622496

22497+
/**
22498+
* if `key` is not JSON-serializable, this contains an encoded version that preserves types.
22499+
*/
22500+
keyEncoded?: Object;
22501+
2246722502
value: Object;
22503+
22504+
/**
22505+
* if `value` is not JSON-serializable, this contains an encoded version that preserves types.
22506+
*/
22507+
valueEncoded?: Object;
2246822508
}>;
2246922509
}>;
2247022510
}>;

0 commit comments

Comments
 (0)