Skip to content

Commit 43dec3b

Browse files
Kle0sOrKoN
Kle0s
and
OrKoN
authored
feat: browser level cookies API (#13316)
Co-authored-by: Alex Rudenko <[email protected]>
1 parent 0c7136f commit 43dec3b

23 files changed

+928
-31
lines changed

‎docs/api/index.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -667,6 +667,13 @@ Description
667667
</td></tr>
668668
<tr><td>
669669

670+
<span id="convertcookiespartitionkeyfrompuppeteertocdp">[convertCookiesPartitionKeyFromPuppeteerToCdp(partitionKey)](./puppeteer.convertcookiespartitionkeyfrompuppeteertocdp.md)</span>
671+
672+
</td><td>
673+
674+
</td></tr>
675+
<tr><td>
676+
670677
<span id="defaultargs">[defaultArgs(options)](./puppeteer.defaultargs.md)</span>
671678

672679
</td><td>
@@ -782,6 +789,15 @@ Launcher options that only apply to Chrome.
782789
</td></tr>
783790
<tr><td>
784791

792+
<span id="chromecookiepartitionkey">[ChromeCookiePartitionKey](./puppeteer.chromecookiepartitionkey.md)</span>
793+
794+
</td><td>
795+
796+
Represents a cookie partition key in Chrome.
797+
798+
</td></tr>
799+
<tr><td>
800+
785801
<span id="chromeheadlessshellsettings">[ChromeHeadlessShellSettings](./puppeteer.chromeheadlessshellsettings.md)</span>
786802

787803
</td><td>

‎docs/api/puppeteer.browser.cookies.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
sidebar_label: Browser.cookies
3+
---
4+
5+
# Browser.cookies() method
6+
7+
Returns all cookies in the default [BrowserContext](./puppeteer.browsercontext.md).
8+
9+
### Signature
10+
11+
```typescript
12+
class Browser {
13+
cookies(): Promise<Cookie[]>;
14+
}
15+
```
16+
17+
**Returns:**
18+
19+
Promise&lt;[Cookie](./puppeteer.cookie.md)\[\]&gt;

‎docs/api/puppeteer.browser.deletecookie.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
sidebar_label: Browser.deleteCookie
3+
---
4+
5+
# Browser.deleteCookie() method
6+
7+
Removes cookies from the default [BrowserContext](./puppeteer.browsercontext.md).
8+
9+
### Signature
10+
11+
```typescript
12+
class Browser {
13+
deleteCookie(...cookies: Cookie[]): Promise<void>;
14+
}
15+
```
16+
17+
## Parameters
18+
19+
<table><thead><tr><th>
20+
21+
Parameter
22+
23+
</th><th>
24+
25+
Type
26+
27+
</th><th>
28+
29+
Description
30+
31+
</th></tr></thead>
32+
<tbody><tr><td>
33+
34+
cookies
35+
36+
</td><td>
37+
38+
[Cookie](./puppeteer.cookie.md)\[\]
39+
40+
</td><td>
41+
42+
</td></tr>
43+
</tbody></table>
44+
**Returns:**
45+
46+
Promise&lt;void&gt;

‎docs/api/puppeteer.browser.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,17 @@ Closes this [browser](./puppeteer.browser.md) and all associated [pages](./puppe
154154
</td></tr>
155155
<tr><td>
156156
157+
<span id="cookies">[cookies()](./puppeteer.browser.cookies.md)</span>
158+
159+
</td><td>
160+
161+
</td><td>
162+
163+
Returns all cookies in the default [BrowserContext](./puppeteer.browsercontext.md).
164+
165+
</td></tr>
166+
<tr><td>
167+
157168
<span id="createbrowsercontext">[createBrowserContext(options)](./puppeteer.browser.createbrowsercontext.md)</span>
158169
159170
</td><td>
@@ -182,6 +193,17 @@ The default [browser context](./puppeteer.browsercontext.md) cannot be closed.
182193
</td></tr>
183194
<tr><td>
184195
196+
<span id="deletecookie">[deleteCookie(cookies)](./puppeteer.browser.deletecookie.md)</span>
197+
198+
</td><td>
199+
200+
</td><td>
201+
202+
Removes cookies from the default [BrowserContext](./puppeteer.browsercontext.md).
203+
204+
</td></tr>
205+
<tr><td>
206+
185207
<span id="disconnect">[disconnect()](./puppeteer.browser.disconnect.md)</span>
186208
187209
</td><td>
@@ -249,6 +271,17 @@ Gets the associated [ChildProcess](https://nodejs.org/api/child_process.html#cla
249271
</td></tr>
250272
<tr><td>
251273
274+
<span id="setcookie">[setCookie(cookies)](./puppeteer.browser.setcookie.md)</span>
275+
276+
</td><td>
277+
278+
</td><td>
279+
280+
Sets cookies in the default [BrowserContext](./puppeteer.browsercontext.md).
281+
282+
</td></tr>
283+
<tr><td>
284+
252285
<span id="target">[target()](./puppeteer.browser.target.md)</span>
253286
254287
</td><td>

‎docs/api/puppeteer.browser.setcookie.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
sidebar_label: Browser.setCookie
3+
---
4+
5+
# Browser.setCookie() method
6+
7+
Sets cookies in the default [BrowserContext](./puppeteer.browsercontext.md).
8+
9+
### Signature
10+
11+
```typescript
12+
class Browser {
13+
setCookie(...cookies: Cookie[]): Promise<void>;
14+
}
15+
```
16+
17+
## Parameters
18+
19+
<table><thead><tr><th>
20+
21+
Parameter
22+
23+
</th><th>
24+
25+
Type
26+
27+
</th><th>
28+
29+
Description
30+
31+
</th></tr></thead>
32+
<tbody><tr><td>
33+
34+
cookies
35+
36+
</td><td>
37+
38+
[Cookie](./puppeteer.cookie.md)\[\]
39+
40+
</td><td>
41+
42+
</td></tr>
43+
</tbody></table>
44+
**Returns:**
45+
46+
Promise&lt;void&gt;

‎docs/api/puppeteer.browsercontext.cookies.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
sidebar_label: BrowserContext.cookies
3+
---
4+
5+
# BrowserContext.cookies() method
6+
7+
Gets all cookies in the browser context.
8+
9+
### Signature
10+
11+
```typescript
12+
class BrowserContext {
13+
abstract cookies(): Promise<Cookie[]>;
14+
}
15+
```
16+
17+
**Returns:**
18+
19+
Promise&lt;[Cookie](./puppeteer.cookie.md)\[\]&gt;

‎docs/api/puppeteer.browsercontext.deletecookie.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
sidebar_label: BrowserContext.deleteCookie
3+
---
4+
5+
# BrowserContext.deleteCookie() method
6+
7+
Removes cookie in the browser context
8+
9+
### Signature
10+
11+
```typescript
12+
class BrowserContext {
13+
deleteCookie(...cookies: Cookie[]): Promise<void>;
14+
}
15+
```
16+
17+
## Parameters
18+
19+
<table><thead><tr><th>
20+
21+
Parameter
22+
23+
</th><th>
24+
25+
Type
26+
27+
</th><th>
28+
29+
Description
30+
31+
</th></tr></thead>
32+
<tbody><tr><td>
33+
34+
cookies
35+
36+
</td><td>
37+
38+
[Cookie](./puppeteer.cookie.md)\[\]
39+
40+
</td><td>
41+
42+
[cookie](./puppeteer.cookie.md) to remove
43+
44+
</td></tr>
45+
</tbody></table>
46+
**Returns:**
47+
48+
Promise&lt;void&gt;

‎docs/api/puppeteer.browsercontext.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,28 @@ The [default browser context](./puppeteer.browser.defaultbrowsercontext.md) cann
150150
</td></tr>
151151
<tr><td>
152152
153+
<span id="cookies">[cookies()](./puppeteer.browsercontext.cookies.md)</span>
154+
155+
</td><td>
156+
157+
</td><td>
158+
159+
Gets all cookies in the browser context.
160+
161+
</td></tr>
162+
<tr><td>
163+
164+
<span id="deletecookie">[deleteCookie(cookies)](./puppeteer.browsercontext.deletecookie.md)</span>
165+
166+
</td><td>
167+
168+
</td><td>
169+
170+
Removes cookie in the browser context
171+
172+
</td></tr>
173+
<tr><td>
174+
153175
<span id="newpage">[newPage()](./puppeteer.browsercontext.newpage.md)</span>
154176
155177
</td><td>
@@ -187,6 +209,17 @@ Non-visible [pages](./puppeteer.page.md), such as `"background_page"`, will not
187209
</td></tr>
188210
<tr><td>
189211
212+
<span id="setcookie">[setCookie(cookies)](./puppeteer.browsercontext.setcookie.md)</span>
213+
214+
</td><td>
215+
216+
</td><td>
217+
218+
Sets a cookie in the browser context.
219+
220+
</td></tr>
221+
<tr><td>
222+
190223
<span id="targets">[targets()](./puppeteer.browsercontext.targets.md)</span>
191224
192225
</td><td>

‎docs/api/puppeteer.browsercontext.setcookie.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
sidebar_label: BrowserContext.setCookie
3+
---
4+
5+
# BrowserContext.setCookie() method
6+
7+
Sets a cookie in the browser context.
8+
9+
### Signature
10+
11+
```typescript
12+
class BrowserContext {
13+
abstract setCookie(...cookies: Cookie[]): Promise<void>;
14+
}
15+
```
16+
17+
## Parameters
18+
19+
<table><thead><tr><th>
20+
21+
Parameter
22+
23+
</th><th>
24+
25+
Type
26+
27+
</th><th>
28+
29+
Description
30+
31+
</th></tr></thead>
32+
<tbody><tr><td>
33+
34+
cookies
35+
36+
</td><td>
37+
38+
[Cookie](./puppeteer.cookie.md)\[\]
39+
40+
</td><td>
41+
42+
[cookie](./puppeteer.cookie.md) to set
43+
44+
</td></tr>
45+
</tbody></table>
46+
**Returns:**
47+
48+
Promise&lt;void&gt;

0 commit comments

Comments
 (0)