File Explorer

1# Cookie Handling2 3## `Cookie` interface4 5* **name** `string`6* **value** `string`7* **expires** `Date|number` (optional)8* **maxAge** `number` (optional)9* **domain** `string` (optional)10* **path** `string` (optional)11* **secure** `boolean` (optional)12* **httpOnly** `boolean` (optional)13* **sameSite** `'String'|'Lax'|'None'` (optional)14* **unparsed** `string[]` (optional) Left over attributes that weren't parsed.15 16## `deleteCookie(headers, name[, attributes])`17 18Sets the expiry time of the cookie to the unix epoch, causing browsers to delete it when received.19 20```js21import { deleteCookie, Headers } from 'undici'22 23const headers = new Headers()24deleteCookie(headers, 'name')25 26console.log(headers.get('set-cookie')) // name=; Expires=Thu, 01 Jan 1970 00:00:00 GMT27```28 29Arguments:30 31* **headers** `Headers`32* **name** `string`33* **attributes** `{ path?: string, domain?: string }` (optional)34 35Returns: `void`36 37## `getCookies(headers)`38 39Parses the `Cookie` header and returns a list of attributes and values.40 41```js42import { getCookies, Headers } from 'undici'43 44const headers = new Headers({45  cookie: 'get=cookies; and=attributes'46})47 48console.log(getCookies(headers)) // { get: 'cookies', and: 'attributes' }49```50 51Arguments:52 53* **headers** `Headers`54 55Returns: `Record<string, string>`56 57## `getSetCookies(headers)`58 59Parses all `Set-Cookie` headers.60 61```js62import { getSetCookies, Headers } from 'undici'63 64const headers = new Headers({ 'set-cookie': 'undici=getSetCookies; Secure' })65 66console.log(getSetCookies(headers))67// [68//   {69//     name: 'undici',70//     value: 'getSetCookies',71//     secure: true72//   }73// ]74 75```76 77Arguments:78 79* **headers** `Headers`80 81Returns: `Cookie[]`82 83## `parseCookie(cookie)`84 85Parses a single `Set-Cookie` header value into a `Cookie` object.86 87```js88import { parseCookie } from 'undici'89 90console.log(parseCookie('undici=getSetCookies; Secure; SameSite=Lax'))91// {92//   name: 'undici',93//   value: 'getSetCookies',94//   secure: true,95//   sameSite: 'Lax'96// }97```98 99Notes:100 101* The cookie value is returned as it appears in the header. Percent-encoded sequences such as `%20` or `%0D%0A` are **not** decoded.102* `sameSite` is only set for exact case-insensitive matches of `Strict`, `Lax`, or `None`.103 104Arguments:105 106* **cookie** `string`107 108Returns: `Cookie | null`109 110## `setCookie(headers, cookie)`111 112Appends a cookie to the `Set-Cookie` header.113 114```js115import { setCookie, Headers } from 'undici'116 117const headers = new Headers()118setCookie(headers, { name: 'undici', value: 'setCookie' })119 120console.log(headers.get('Set-Cookie')) // undici=setCookie121```122 123Arguments:124 125* **headers** `Headers`126* **cookie** `Cookie`127 128Returns: `void`129