From 292077142100006126e2e9af64b945d77920ad1f Mon Sep 17 00:00:00 2001 From: JoscelynJean Date: Mon, 15 Jun 2020 09:17:43 -0400 Subject: [PATCH] fix: using old scoped dependency in documentation and examples --- README.md | 20 ++++++++++++++++++-- examples/simple-use/Dockerfile | 2 +- examples/simple-use/package.json | 6 +++--- examples/simple-use/src/index.js | 24 ++++++++++++------------ package.json | 2 +- 5 files changed, 35 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 4d06689..04c7569 100644 --- a/README.md +++ b/README.md @@ -34,12 +34,20 @@ For examples, check the `examples` folder. Install the dependency. ``` -$ npm install @villedemontreal/idempotency-express +$ npm install express-idempotency ``` Integrate the middleware in your Express initialization. ```javascript +// Javascript +const idempotency = require('express-idempotency'); +// ...express initialization +app.post('*', idempotency.idempotency()); + +// Typescript +import { idempotency } from 'express-idempotency'; +// ...express initialization app.post('*', idempotency()); ``` @@ -180,12 +188,20 @@ Pour des exemples, voir le répertoire `examples`. Installation de la dépendance. ``` -$ npm install @villedemontreal/idempotency-express +$ npm install express-idempotency ``` Intégrer le middleware dans l'initialisation de votre application Express. ```javascript +// Javascript +const idempotency = require('express-idempotency'); +// ...initialisation de Express +app.post('*', idempotency.idempotency()); + +// Typescript +import { idempotency } from 'express-idempotency'; +// ...initialisation de Express app.post('*', idempotency()); ``` diff --git a/examples/simple-use/Dockerfile b/examples/simple-use/Dockerfile index 940854e..ae66bf6 100644 --- a/examples/simple-use/Dockerfile +++ b/examples/simple-use/Dockerfile @@ -11,7 +11,7 @@ RUN npm install && npm run compile && npm link # Installation of package to run the application WORKDIR /usr/src/app/examples/simple-use -RUN npm link "@villemontreal/express-idempotency" && npm install +RUN npm link "express-idempotency" && npm install EXPOSE 8080 diff --git a/examples/simple-use/package.json b/examples/simple-use/package.json index e36a616..81fb71d 100644 --- a/examples/simple-use/package.json +++ b/examples/simple-use/package.json @@ -1,5 +1,5 @@ { - "name": "@villemontreal/express-idempotency-example", + "name": "express-idempotency-example", "version": "1.0.0", "description": "", "main": "index.js", @@ -9,7 +9,7 @@ "author": "", "license": "MIT", "dependencies": { - "@villemontreal/express-idempotency": "1.0.0", + "express-idempotency": "1.0.2", "express": "^4.17.1" } -} \ No newline at end of file +} diff --git a/examples/simple-use/src/index.js b/examples/simple-use/src/index.js index fd7bbb4..6e58e10 100644 --- a/examples/simple-use/src/index.js +++ b/examples/simple-use/src/index.js @@ -4,23 +4,23 @@ const express = require('express'); const app = express(); -const idempotency = require('@villemontreal/express-idempotency'); +const idempotency = require('express-idempotency'); app.use(idempotency.idempotency()); app.all('/', function (req, res) { - const idempotencyService = idempotency.getSharedIdempotencyService(); - if (idempotencyService.isHit(req)) { - console.log('Idempotency middleware did already process the request!'); - return; - } + const idempotencyService = idempotency.getSharedIdempotencyService(); + if (idempotencyService.isHit(req)) { + console.log('Idempotency middleware did already process the request!'); + return; + } - // Return the current date and time - res.send(new Date().toISOString()); + // Return the current date and time + res.send(new Date().toISOString()); }); app.listen(8080, function () { - console.log( - 'Example app listening on port 8080 with express-idempotency middleware.' - ); -}); \ No newline at end of file + console.log( + 'Example app listening on port 8080 with express-idempotency middleware.' + ); +}); diff --git a/package.json b/package.json index 4f033b7..862a236 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "express-idempotency", - "version": "1.0.1", + "version": "1.0.2", "description": "", "main": "dist/index.js", "typings": "dist/index.d.ts",