Skip to content

Remove deprecations from README #279

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
blakeembrey merged 1 commit into from
Jun 24, 2026
Merged

Remove deprecations from README #279

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 1 addition & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,11 @@ $ npm install cookie
## API

```js
const cookie = require("cookie");
// import * as cookie from 'cookie';
import * as cookie from "cookie";
```

### cookie.parseCookie(str, options)

Alias: `parse(str, options)` ([deprecated](#deprecated))

Parse an HTTP `Cookie` header string and return an [object](#cookie-object) of all cookie name-value pairs.
The `str` argument is the string representing a `Cookie` header value and `options` is an
optional object containing additional parsing options.
Expand Down Expand Up @@ -74,8 +71,6 @@ cookie.parseSetCookie(

### cookie.stringifySetCookie(setCookieObj, options)

Alias: `serialize(str, val, options)` ([deprecated](#deprecated))

Stringifies a [`Set-Cookie` object](#set-cookie-object) into a `Set-Cookie` header string.

```js
Expand Down Expand Up @@ -243,14 +238,6 @@ function onRequest(req, res) {
http.createServer(onRequest).listen(3000);
```

## Deprecated

These APIs will be removed in the future:

- `parse` - use new `parseCookie` name
- `stringify` - use new `stringifySetCookie` name
- `stringify(str, val, opts)` - use `stringifySetCookie(obj, opts)`

## Testing

```sh
Expand Down
Loading