nookies - npm Package Compare versions

Comparing version 2.3.2 to 2.4.0

dist/index.d.ts

 import * as cookie from 'cookie';
 import * as next from 'next';
+import * as express from 'express';
 /**
@@ -12,2 +13,4 @@ *
     req: next.NextApiRequest;
+} | {
+    req: express.Request;
 } | null | undefined, options?: cookie.CookieParseOptions): {
@@ -27,2 +30,4 @@ [key: string]: string;
     res: next.NextApiResponse;
+} | {
+    res: express.Response;
 } | null | undefined, name: string, value: string, options: cookie.CookieSerializeOptions): {};
@@ -39,2 +44,4 @@ /**
     res: next.NextApiResponse;
+} | {
+    res: express.Response;
 } | null | undefined, name: string, options?: cookie.CookieSerializeOptions): {};
@@ -41,0 +48,0 @@ declare const _default: {

dist/index.js

@@ -36,4 +36,4 @@ "use strict";
  *
- * @param a first Cookie for comparision
- * @param b second Cookie for comparision
+ * @param a first Cookie for comparison
+ * @param b second Cookie for comparison
  */
@@ -40,0 +40,0 @@ function areCookiesEqual(a, b) {

package.json

 {
   "name": "nookies",
   "description": "A set of cookie helpers for Next.js",
-  "version": "2.3.2",
+  "version": "2.4.0",
   "main": "dist/index.js",
@@ -31,4 +31,5 @@ "types": "dist/index.d.ts",
     "@types/cookie": "0.4.0",
+    "@types/express": "^4.17.7",
     "@types/next": "9.0.0",
-    "@types/node": "13.13.12",
+    "@types/node": "13.13.15",
     "@types/set-cookie-parser": "0.0.6",
@@ -40,10 +41,10 @@ "husky": "4.2.5",
     "rimraf": "3.0.2",
-    "semantic-release": "17.0.8",
+    "semantic-release": "17.1.1",
     "terser": "4.8.0",
     "ts-loader": "6.2.2",
     "ts-node": "8.10.2",
-    "tslint": "6.1.2",
+    "tslint": "6.1.3",
     "tslint-config-prettier": "1.18.0",
     "tslint-config-standard": "9.0.0",
-    "typescript": "3.9.5"
+    "typescript": "3.9.7"
   },
@@ -50,0 +51,0 @@ "keywords": [

README.md

@@ -8,2 +8,3 @@ # nookies :cookie: :cookie: :cookie:
 - SSR support, for setter, parser and destroy
+- Custom Express server support
 - super light
@@ -120,2 +121,34 @@ - perfect for authentication
 
+## Custom Express server cookies
+
+```js
+const express = require('express');
+const dev = process.env.NODE_ENV !== 'production';
+const app = next({ dev });
+const handle = app.getRequestHandler();
+const { parseCookies, setCookie, destroyCookie } = require('nookies');
+
+app.prepare()
+    .then(() => {
+        const server = express();
+
+        server.get('/page', (req, res) => {
+
+          // Notice how the request object is passed
+          const parsedCookies = parseCookies({ req });
+
+          // Notice how the response object is passed
+          setCookie({ res }, 'fromServer', 'value', {
+            maxAge: 30 * 24 * 60 * 60,
+            path: '/page',
+          });
+
+          // destroyCookie({ res }, 'fromServer');
+
+          return handle(req, res);
+        });
+
+    );
+```
+
 ## Reference
@@ -127,3 +160,3 @@
 
-- **ctx:** `Next.js context`
+- **ctx:** `Next.js context` || `(Express request object)`
 - **options:**
@@ -134,3 +167,3 @@ - **decode:** `a custom resolver function (default: decodeURIComponent)`
 
-- **ctx:** `(Next.js context)`
+- **ctx:** `(Next.js context)` || `(Express request object)`
 - **name:** cookie name
@@ -150,3 +183,3 @@ - **value:** cookie value
 
-- **ctx:** (Next.js context)
+- **ctx:** `(Next.js context)` || `(Express response object)`
 - **name:** cookie name
@@ -153,0 +186,0 @@ - **options:**

src/index.ts

@@ -5,2 +5,3 @@ import * as cookie from 'cookie'
 import { Cookie } from 'set-cookie-parser'
+import * as express from 'express'
 
@@ -32,4 +33,4 @@ const isBrowser = () => typeof window !== 'undefined'
  *
- * @param a first Cookie for comparision
- * @param b second Cookie for comparision
+ * @param a first Cookie for comparison
+ * @param b second Cookie for comparison
  */
@@ -88,2 +89,3 @@ function areCookiesEqual(a: Cookie, b: Cookie) {
     | { req: next.NextApiRequest }
+    | { req: express.Request }
     | null
@@ -117,2 +119,3 @@ | undefined,
     | { res: next.NextApiResponse }
+    | { res: express.Response }
     | null
@@ -172,2 +175,3 @@ | undefined,
     | { res: next.NextApiResponse }
+    | { res: express.Response }
     | null
@@ -174,0 +178,0 @@ | undefined,

No alert changes

Improved metrics

Total package byte prevSize

27992

increased by4.5%

Lines of code

421

increased by2.68%

Number of lines in readme file

188

increased by21.29%

Worsened metrics

Dev dependency count

18

increased by5.88%

No dependency changes