refactor: prefix unused params with underscores

example/example-auto-pipeline.mjs

@@ -33,7 +33,7 @@ fastify.get('/', {
       timeWindow: '1 minute'
     }
   }
-}, (req, reply) => {
+}, (_req, reply) => {
   reply.send({ hello: 'from ... root' })
 })
 
@@ -45,11 +45,11 @@ fastify.get('/private', {
       timeWindow: '1 minute'
     }
   }
-}, (req, reply) => {
+}, (_req, reply) => {
   reply.send({ hello: 'from ... private' })
 })
 
-fastify.get('/public', (req, reply) => {
+fastify.get('/public', (_req, reply) => {
   reply.send({ hello: 'from ... public' })
 })
 
@@ -58,15 +58,15 @@ fastify.get('/public/sub-rated-1', {
     rateLimit: {
       timeWindow: '1 minute',
       allowList: ['127.0.2.1'],
-      onExceeding: function (req) {
+      onExceeding: function () {
         console.log('callback on exceededing ... executed before response to client. req is give as argument')
       },
-      onExceeded: function (req) {
+      onExceeded: function () {
         console.log('callback on exceeded ... to black ip in security group for example, req is give as argument')
       }
     }
   }
-}, (req, reply) => {
+}, (_req, reply) => {
   reply.send({ hello: 'from sub-rated-1 ... using default max value ... ' })
 })
 
@@ -75,15 +75,15 @@ fastify.get('/public/sub-rated-2', {
     rateLimit: {
       max: 3,
       timeWindow: '1 minute',
-      onExceeding: function (req) {
+      onExceeding: function () {
         console.log('callback on exceededing ... executed before response to client. req is give as argument')
       },
-      onExceeded: function (req) {
+      onExceeded: function () {
         console.log('callback on exceeded ... to black ip in security group for example, req is give as argument')
       }
     }
   }
-}, (req, reply) => {
+}, (_req, reply) => {
   reply.send({ hello: 'from ... sub-rated-2' })
 })
 
@@ -94,7 +94,7 @@ fastify.get('/home', {
       timeWindow: '1 minute'
     }
   }
-}, (req, reply) => {
+}, (_req, reply) => {
   reply.send({ hello: 'toto' })
 })
 
@@ -103,10 +103,10 @@ fastify.get('/customerrormessage', {
     rateLimit: {
       max: 2,
       timeWindow: '1 minute',
-      errorResponseBuilder: (req, context) => ({ code: 429, timeWindow: context.after, limit: context.max })
+      errorResponseBuilder: (_req, context) => ({ code: 429, timeWindow: context.after, limit: context.max })
     }
   }
-}, (req, reply) => {
+}, (_req, reply) => {
   reply.send({ hello: 'toto' })
 })
 

example/example-knex-mysql.js

@@ -66,8 +66,8 @@ KnexStore.prototype.incr = async function (key, cb) {
       process.nextTick(cb, null, { current: d.count + 1, ttl: d.ttl })
     } else {
       await trx
-        .raw('INSERT INTO rate_limits(route, source, count, ttl) VALUES(?,?,1,?) ON DUPLICATE KEY UPDATE count = 1, ttl = ?', [cond.route, key, (d && d.ttl) || ttl, ttl])
-      process.nextTick(cb, null, { current: 1, ttl: (d && d.ttl) || ttl })
+        .raw('INSERT INTO rate_limits(route, source, count, ttl) VALUES(?,?,1,?) ON DUPLICATE KEY UPDATE count = 1, ttl = ?', [cond.route, key, d?.ttl || ttl, ttl])
+      process.nextTick(cb, null, { current: 1, ttl: d?.ttl || ttl })
     }
     await trx.commit()
   } catch (err) {
@@ -104,7 +104,7 @@ fastify.get('/', {
       timeWindow: '1 minute'
     }
   }
-}, (req, reply) => {
+}, (_req, reply) => {
   reply.send({ hello: 'from ... root' })
 })
 
@@ -115,10 +115,10 @@ fastify.get('/private', {
       timeWindow: '1 minute'
     }
   }
-}, (req, reply) => {
+}, (_req, reply) => {
   reply.send({ hello: 'from ... private' })
 })
 
-fastify.get('/public', (req, reply) => {
+fastify.get('/public', (_req, reply) => {
   reply.send({ hello: 'from ... public' })
 })

example/example-knex.js

@@ -93,7 +93,7 @@ fastify.get('/', {
       timeWindow: '1 minute'
     }
   }
-}, (req, reply) => {
+}, (_req, reply) => {
   reply.send({ hello: 'from ... root' })
 })
 
@@ -104,11 +104,11 @@ fastify.get('/private', {
       timeWindow: '1 minute'
     }
   }
-}, (req, reply) => {
+}, (_req, reply) => {
   reply.send({ hello: 'from ... private' })
 })
 
-fastify.get('/public', (req, reply) => {
+fastify.get('/public', (_req, reply) => {
   reply.send({ hello: 'from ... public' })
 })
 

example/example-sequelize.js

@@ -120,13 +120,13 @@ RateLimiterStore.prototype.incr = async function incr (key, cb) {
     sequelize.query(
             `INSERT INTO "RateLimits"("Route", "Source", "Count", "TTL")
             VALUES('${this.route}', '${key}', 1,
-            ${(RateLimit && RateLimit.TTL) || ttl})
+            ${RateLimit?.TTL || ttl})
             ON CONFLICT("Route", "Source") DO UPDATE SET "Count"=1, "TTL"=${ttl}`
     )
       .then(() => {
         cb(null, {
           current: 1,
-          ttl: (RateLimit && RateLimit.TTL) || ttl
+          ttl: RateLimit?.TTL || ttl
         })
       })
       .catch(err => {
@@ -160,7 +160,7 @@ fastify.get('/', {
       timeWindow: '1 minute'
     }
   }
-}, (req, reply) => {
+}, (_req, reply) => {
   reply.send({ hello: 'from ... root' })
 })
 
@@ -171,11 +171,11 @@ fastify.get('/private', {
       timeWindow: '1 minute'
     }
   }
-}, (req, reply) => {
+}, (_req, reply) => {
   reply.send({ hello: 'from ... private' })
 })
 
-fastify.get('/public', (req, reply) => {
+fastify.get('/public', (_req, reply) => {
   reply.send({ hello: 'from ... public' })
 })
 

example/example-simple.mjs

@@ -9,7 +9,7 @@ await server.register(fastifyRateLimit, {
   timeWindow: '1 minute'
 })
 
-server.get('/', (request, reply) => {
+server.get('/', (_request, reply) => {
   reply.send('Hello, world!')
 })
 

example/example.js

@@ -30,7 +30,7 @@ fastify.get('/', {
       timeWindow: '1 minute'
     }
   }
-}, (req, reply) => {
+}, (_req, reply) => {
   reply.send({ hello: 'from ... root' })
 })
 
@@ -42,11 +42,11 @@ fastify.get('/private', {
       timeWindow: '1 minute'
     }
   }
-}, (req, reply) => {
+}, (_req, reply) => {
   reply.send({ hello: 'from ... private' })
 })
 
-fastify.get('/public', (req, reply) => {
+fastify.get('/public', (_req, reply) => {
   reply.send({ hello: 'from ... public' })
 })
 
@@ -55,15 +55,15 @@ fastify.get('/public/sub-rated-1', {
     rateLimit: {
       timeWindow: '1 minute',
       allowList: ['127.0.2.1'],
-      onExceeding: function (req) {
+      onExceeding: function () {
         console.log('callback on exceededing ... executed before response to client. req is give as argument')
       },
-      onExceeded: function (req) {
+      onExceeded: function () {
         console.log('callback on exceeded ... to black ip in security group for example, req is give as argument')
       }
     }
   }
-}, (req, reply) => {
+}, (_req, reply) => {
   reply.send({ hello: 'from sub-rated-1 ... using default max value ... ' })
 })
 
@@ -72,15 +72,15 @@ fastify.get('/public/sub-rated-2', {
     rateLimit: {
       max: 3,
       timeWindow: '1 minute',
-      onExceeding: function (req) {
+      onExceeding: function () {
         console.log('callback on exceededing ... executed before response to client. req is give as argument')
       },
-      onExceeded: function (req) {
+      onExceeded: function () {
         console.log('callback on exceeded ... to black ip in security group for example, req is give as argument')
       }
     }
   }
-}, (req, reply) => {
+}, (_req, reply) => {
   reply.send({ hello: 'from ... sub-rated-2' })
 })
 
@@ -91,7 +91,7 @@ fastify.get('/home', {
       timeWindow: '1 minute'
     }
   }
-}, (req, reply) => {
+}, (_req, reply) => {
   reply.send({ hello: 'toto' })
 })
 
@@ -100,10 +100,10 @@ fastify.get('/customerrormessage', {
     rateLimit: {
       max: 2,
       timeWindow: '1 minute',
-      errorResponseBuilder: (req, context) => ({ code: 429, timeWindow: context.after, limit: context.max })
+      errorResponseBuilder: (_req, context) => ({ code: 429, timeWindow: context.after, limit: context.max })
     }
   }
-}, (req, reply) => {
+}, (_req, reply) => {
   reply.send({ hello: 'toto' })
 })
 

index.js

@@ -28,7 +28,7 @@ const defaultOnFn = () => {}
 
 const defaultKeyGenerator = (req) => req.ip
 
-const defaultErrorResponse = (req, context) => {
+const defaultErrorResponse = (_req, context) => {
   const err = new Error(`Rate limit exceeded, retry in ${context.after}`)
   err.statusCode = context.statusCode
   return err

test/exponential-backoff.test.js

@@ -6,7 +6,7 @@ const rateLimit = require('../index')
 
 const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms))
 
-test('Exponential Backoff', async (t) => {
+test('Exponential Backoff', async () => {
   const fastify = Fastify()
 
   // Register rate limit plugin with exponentialBackoff set to true in routeConfig
@@ -23,7 +23,7 @@ test('Exponential Backoff', async (t) => {
         }
       }
     },
-    async (req, reply) => 'exponential backoff applied!'
+    async () => 'exponential backoff applied!'
   )
 
   // Test
@@ -71,7 +71,7 @@ test('Exponential Backoff', async (t) => {
   assert.deepStrictEqual(res5.headers['x-ratelimit-remaining'], '1')
 })
 
-test('Global Exponential Backoff', async (t) => {
+test('Global Exponential Backoff', async () => {
   const fastify = Fastify()
 
   // Register rate limit plugin with exponentialBackoff set to true in routeConfig
@@ -87,7 +87,7 @@ test('Global Exponential Backoff', async (t) => {
         }
       }
     },
-    async (req, reply) => 'exponential backoff applied!'
+    async () => 'exponential backoff applied!'
   )
 
   // Test
@@ -151,7 +151,7 @@ test('Global Exponential Backoff', async (t) => {
   )
 })
 
-test('MAx safe Exponential Backoff', async (t) => {
+test('MAx safe Exponential Backoff', async () => {
   const fastify = Fastify()
 
   // Register rate limit plugin with exponentialBackoff set to true in routeConfig
@@ -167,7 +167,7 @@ test('MAx safe Exponential Backoff', async (t) => {
         }
       }
     },
-    async (req, reply) => 'exponential backoff applied!'
+    async () => 'exponential backoff applied!'
   )
 
   // Test

test/github-issues/issue-284.test.js

@@ -13,7 +13,7 @@ test("issue #284 - don't set the reply code automatically", async (t) => {
     global: false
   })
 
-  fastify.setErrorHandler((err, req, res) => {
+  fastify.setErrorHandler((err, _req, res) => {
     t.assert.deepStrictEqual(res.statusCode, 200)
     t.assert.deepStrictEqual(err.statusCode, 429)