feat: add named export for memory store (#292)

Author: gamemaker1

package.json

@@ -50,7 +50,7 @@
 	},
 	"scripts": {
 		"clean": "del-cli dist/ coverage/ *.log *.tmp *.bak *.tgz",
-		"build:cjs": "esbuild --bundle --format=cjs --outfile=dist/index.cjs --footer:js=\"module.exports = rateLimit; module.exports.default = rateLimit; module.exports.rateLimit = rateLimit;\" source/index.ts",
+		"build:cjs": "esbuild --bundle --format=cjs --outfile=dist/index.cjs --footer:js=\"module.exports = rateLimit; module.exports.default = rateLimit; module.exports.rateLimit = rateLimit; module.exports.MemoryStore = MemoryStore;\" source/index.ts",
 		"build:esm": "esbuild --bundle --format=esm --outfile=dist/index.mjs source/index.ts",
 		"build:types": "dts-bundle-generator --out-file=dist/index.d.ts source/index.ts",
 		"compile": "run-s clean build:*",

readme.md

@@ -139,8 +139,7 @@ app.post('/create-account', createAccountLimiter, (request, response) => {
 To use a custom store:
 
 ```ts
-import rateLimit from 'express-rate-limit'
-import MemoryStore from 'express-rate-limit/memory-store.js'
+import rateLimit, { MemoryStore } from 'express-rate-limit'
 
 const apiLimiter = rateLimit({
 	windowMs: 15 * 60 * 1000, // 15 minutes

source/index.ts

@@ -7,3 +7,7 @@ export * from './types.js'
 // Export the rateLimit function as a default export and as a named export, if
 // the default export does not work (see https://github.com/nfriedly/express-rate-limit/issues/280)
 export { default, default as rateLimit } from './lib.js'
+
+// Export the memory store in case someone wants to use or extend it
+// (see https://github.com/nfriedly/express-rate-limit/issues/289)
+export { default as MemoryStore } from './memory-store.js'

test/external/imports/default-import/js-cjs/source/app.js

@@ -3,10 +3,18 @@
 
 const createServer = require('express')
 const rateLimit = require('express-rate-limit')
+const { MemoryStore } = require('express-rate-limit')
 
 const app = createServer()
 
-app.use(rateLimit({ max: 2 }))
+app.use(
+	rateLimit({
+		max: 2,
+		legacyHeaders: false,
+		standardHeaders: true,
+		store: new MemoryStore(),
+	}),
+)
 
 app.get('/', (request, response) => response.send('Hello!'))
 

test/external/imports/default-import/js-esm/source/app.js

@@ -2,11 +2,18 @@
 // Create a basic server that uses express-rate-limit to rate limit requests
 
 import createServer from 'express'
-import rateLimit from 'express-rate-limit'
+import rateLimit, { MemoryStore } from 'express-rate-limit'
 
 const app = createServer()
 
-app.use(rateLimit({ max: 2 }))
+app.use(
+	rateLimit({
+		max: 2,
+		legacyHeaders: false,
+		standardHeaders: true,
+		store: new MemoryStore(),
+	}),
+)
 
 app.get('/', (request, response) => response.send('Hello!'))
 

test/external/imports/default-import/ts-cjs/source/app.ts

@@ -2,7 +2,11 @@
 // Create a basic server that uses express-rate-limit to rate limit requests
 
 import createServer from 'express'
-import rateLimit, { Store, IncrementResponse } from 'express-rate-limit'
+import rateLimit, {
+	MemoryStore,
+	Store,
+	IncrementResponse,
+} from 'express-rate-limit'
 
 class TestStore implements Store {
 	hits: Record<string, number> = {}
@@ -28,7 +32,14 @@ class TestStore implements Store {
 
 const app = createServer()
 
-app.use(rateLimit({ max: 2, store: new TestStore() }))
+app.use(
+	rateLimit({
+		max: 2,
+		legacyHeaders: false,
+		standardHeaders: true,
+		store: Math.floor(Math.random() * 2) ? new TestStore() : new MemoryStore(),
+	}),
+)
 
 app.get('/', (request, response) => response.send('Hello!'))
 

test/external/imports/default-import/ts-esm/source/app.ts

@@ -2,7 +2,11 @@
 // Create a basic server that uses express-rate-limit to rate limit requests
 
 import createServer from 'express'
-import rateLimit, { Store, IncrementResponse } from 'express-rate-limit'
+import rateLimit, {
+	MemoryStore,
+	Store,
+	IncrementResponse,
+} from 'express-rate-limit'
 
 class TestStore implements Store {
 	hits: Record<string, number> = {}
@@ -28,7 +32,14 @@ class TestStore implements Store {
 
 const app = createServer()
 
-app.use(rateLimit({ max: 2, store: new TestStore() }))
+app.use(
+	rateLimit({
+		max: 2,
+		legacyHeaders: false,
+		standardHeaders: true,
+		store: Math.floor(Math.random() * 2) ? new TestStore() : new MemoryStore(),
+	}),
+)
 
 app.get('/', (request, response) => response.send('Hello!'))
 

test/external/imports/named-import/js-cjs/source/app.js

@@ -2,11 +2,18 @@
 // Create a basic server that uses express-rate-limit to rate limit requests
 
 const createServer = require('express')
-const { rateLimit } = require('express-rate-limit')
+const { rateLimit, MemoryStore } = require('express-rate-limit')
 
 const app = createServer()
 
-app.use(rateLimit({ max: 2 }))
+app.use(
+	rateLimit({
+		max: 2,
+		legacyHeaders: false,
+		standardHeaders: true,
+		store: new MemoryStore(),
+	}),
+)
 
 app.get('/', (request, response) => response.send('Hello!'))
 

test/external/imports/named-import/js-esm/source/app.js

@@ -2,11 +2,18 @@
 // Create a basic server that uses express-rate-limit to rate limit requests
 
 import createServer from 'express'
-import { rateLimit } from 'express-rate-limit'
+import { rateLimit, MemoryStore } from 'express-rate-limit'
 
 const app = createServer()
 
-app.use(rateLimit({ max: 2 }))
+app.use(
+	rateLimit({
+		max: 2,
+		legacyHeaders: false,
+		standardHeaders: true,
+		store: new MemoryStore(),
+	}),
+)
 
 app.get('/', (request, response) => response.send('Hello!'))
 

test/external/imports/named-import/ts-cjs/source/app.ts

@@ -2,7 +2,12 @@
 // Create a basic server that uses express-rate-limit to rate limit requests
 
 import createServer from 'express'
-import { rateLimit, Store, IncrementResponse } from 'express-rate-limit'
+import {
+	rateLimit,
+	MemoryStore,
+	Store,
+	IncrementResponse,
+} from 'express-rate-limit'
 
 class TestStore implements Store {
 	hits: Record<string, number> = {}
@@ -28,7 +33,14 @@ class TestStore implements Store {
 
 const app = createServer()
 
-app.use(rateLimit({ max: 2, store: new TestStore() }))
+app.use(
+	rateLimit({
+		max: 2,
+		legacyHeaders: false,
+		standardHeaders: true,
+		store: Math.floor(Math.random() * 2) ? new TestStore() : new MemoryStore(),
+	}),
+)
 
 app.get('/', (request, response) => response.send('Hello!'))
 

test/external/imports/named-import/ts-esm/source/app.ts

@@ -2,7 +2,12 @@
 // Create a basic server that uses express-rate-limit to rate limit requests
 
 import createServer from 'express'
-import { rateLimit, Store, IncrementResponse } from 'express-rate-limit'
+import {
+	rateLimit,
+	MemoryStore,
+	Store,
+	IncrementResponse,
+} from 'express-rate-limit'
 
 class TestStore implements Store {
 	hits: Record<string, number> = {}
@@ -28,7 +33,14 @@ class TestStore implements Store {
 
 const app = createServer()
 
-app.use(rateLimit({ max: 2, store: new TestStore() }))
+app.use(
+	rateLimit({
+		max: 2,
+		legacyHeaders: false,
+		standardHeaders: true,
+		store: Math.floor(Math.random() * 2) ? new TestStore() : new MemoryStore(),
+	}),
+)
 
 app.get('/', (request, response) => response.send('Hello!'))