Docs: rateLimitFactory example for ERR_ERL_CREATED_IN_REQUEST_HANDLER

Relates to #453
express-rate-limit · Apr 8, 2024 · 562d5fc · 562d5fc
1 parent e0b1032
commit 562d5fc
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/docs/reference/error-codes.mdx b/docs/reference/error-codes.mdx
@@ -245,6 +245,18 @@ app.use(rateLimit({
 }))
 ```
 
+If using a factory function to create express-rate-limit instances, ensure that
+it is called at app initialization, not in response to each request:
+
+```diff
+  function rateLimitFactory() {
+  	return rateLimit({/*...*/});
+  }
+
+- app.use(rateLimitFactory); // Broken
++ app.use(rateLimitFactory()); // Works
+```
+
 Set `validate: {creationStack: false}` in the options to disable the check.
 
 ## Warnings