Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/platypusrex/next-universal-cookies
Cookie helpers/utils for Next.js applications
https://github.com/platypusrex/next-universal-cookies
cookiejs cookies nextjs
Last synced: 7 days ago
JSON representation
Cookie helpers/utils for Next.js applications
- Host: GitHub
- URL: https://github.com/platypusrex/next-universal-cookies
- Owner: platypusrex
- License: mit
- Created: 2021-09-23T01:41:56.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-01-28T18:23:56.000Z (almost 3 years ago)
- Last Synced: 2024-10-01T13:39:58.642Z (about 1 month ago)
- Topics: cookiejs, cookies, nextjs
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/next-universal-cookies
- Size: 563 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 🍪 next-universal-cookies 🍪
[](https://www.npmjs.org/package/next-universal-cookies)
[](https://github.com/platypusrex/next-universal-cookies/blob/master/LICENSE)
[](https://coveralls.io/github/platypusrex/next-universal-cookies?branch=master)
A proper collection of cookie helpers for use on both the client and server in Next.js applications
### Installation
npm
```shell script
npm install --save next-universal-cookies
```
or yarn
```shell script
yarn add next-universal-cookies
```
### Usage
#### Server
Any of the set of helpers can be utilized in `getServerSideProps`, `getInitialProps`, API routes.
For either `getServerSideProps` | `getInitialProps`, just pass in the context object as the first argument.
If using the helpers in next API routes, pass `req` and `res` as an object in the first parameter:
```typescript
import { parseCookies } from 'next-universal-cookies';
const cookies = parseCookies({ req, res })
```
```typescript
// Parsing
import { getCookieValue, parseCookies } from 'next-universal-cookies';
// Parse all cookies
const cookies = parseCookies(ctx);
// Parse and get single cookie value by name
const cookieValue = getCookieValue(ctx, 'cookie'); // returns string
// Parse and get multple cookie values by name
const { cookie, cookie2 } = getCookieValue(ctx, ['cookie', 'cookie2']); // returns object of values
```
```typescript
// Setting
import { setCookie } from 'next-universal-cookies';
// Set single cookie
setCookie(ctx, {
name: 'cookie',
value: 'cookie-value',
options: {
path: '/my-path',
sameSite: 'strict'
}
});
// or Set multiple cookies
setCookie(ctx, [
{
name: 'cookie',
value: 'cookie-value',
options: {
path: '/my-path',
sameSite: 'strict',
},
},
{
name: 'cookie-too',
value: 'cookie-value-too',
},
]);
```
```typescript
// Destroying
import { destroyCookie } from 'next-universal-cookies';
// Destory cookie with name 'cookie'
destroyCookie(ctx, 'cookie');
```
#### Client
The cookie helpers can also be utilized on the client. The function's input signature
is slightly altered when used client side. The `context` object is no longer required as
an argument.
```typescript
// Parsing
import { getCookieValue, parseCookies } from 'next-universal-cookies';
// Parse all cookies
const cookies = parseCookies();
// Parse and get single cookie value
const cookieValue = getCookieValue('cookie'); // returns string
// Parse and get multple cookie values by name
const { cookie, cookie2 } = getCookieValue(['cookie', 'cookie2']); // returns object of values
```
```typescript
// Setting
import { setCookie } from 'next-universal-cookies';
// Set single cookie
setCookie({
name: 'cookie',
value: 'cookie-value',
options: {
path: '/my-path',
sameSite: 'strict'
}
});
// or Set multiple cookies
setCookie([
{
name: 'cookie',
value: 'cookie-value',
options: {
path: '/my-path',
sameSite: 'strict',
},
},
{
name: 'cookie-too',
value: 'cookie-value-too',
},
]);
```
```typescript
// Destroying
import { destroyCookie } from 'next-universal-cookies';
// Destory cookie with name 'cookie'
destroyCookie('cookie');
```
### Contributors
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
### LICENSE
MIT