stash: everything

Author: gamemaker1

examples/deno/fetch.ts

@@ -5,6 +5,9 @@ import { getRateLimit } from '../../dist/index.mjs'
 
 // Make a GET request to the Imgur API.
 const response = await fetch('https://api.imgur.com/post/v1/posts/t/aww')
-console.log('imgur ratelimit:', getRateLimit(response))
+console.log(
+	'imgur ratelimit:',
+	JSON.stringify(getRateLimit(response), undefined, 2),
+)
 
 // > imgur ratelimit: { limit: 500, used: 1, remaining: 499, reset: 2023-08-25T04:16:48.000Z }

examples/node/axios.ts

@@ -6,6 +6,9 @@ import { getRateLimit } from 'ratelimit-header-parser'
 
 // Make a GET request to the GitHub API.
 const response = await axios('https://api.github.com/orgs/express-rate-limit')
-console.log('github ratelimit:', getRateLimit(response))
+console.log(
+	'github ratelimit:',
+	JSON.stringify(getRateLimit(response), undefined, 2),
+)
 
 // > github ratelimit: { limit: 60, used: 1, remaining: 59, reset: 2023-08-25T04:16:48.000Z }

examples/node/draft-7-fetch.ts

@@ -15,9 +15,9 @@ import { rateLimit } from 'express-rate-limit'
 const app = express()
 app.use(
 	rateLimit({
-		max: 5,
+		limit: 5,
 		windowMs: 60 * 1000, // 1 minute windows.
-		legacyHeader: false, // Disable the `X-RateLimit-*` headers.
+		legacyHeaders: false, // Disable the `X-RateLimit-*` headers.
 		standardHeaders: 'draft-7', // Use the combined `RateLimit` header.
 	}),
 )
@@ -40,8 +40,15 @@ import { getRateLimit } from 'ratelimit-header-parser'
 const response = await fetch(`http://localhost:${port}`)
 
 console.log('`RateLimit` header content:', response.headers.get('RateLimit'))
+console.log(
+	'`RateLimit-Policy` header content:',
+	response.headers.get('RateLimit-Policy'),
+)
 // > `RateLimit` header content: limit=5, remaining=4, reset=60
-console.log('parsed rate limit info:', getRateLimit(response))
+console.log(
+	'parsed rate limit info:',
+	JSON.stringify(getRateLimit(response), undefined, 2),
+)
 // > parsed rate limit info: { limit: 5, used: 1, remaining: 4, reset: 2023-08-25T04:41:31.546Z }
 
 // Cleanup the server.

examples/node/draft-8-fetch.ts

@@ -0,0 +1,61 @@
+// /examples/node/draft-88-fetch.ts
+// Use `fetch`, and parse the `RateLimit` header from the IETF spec's 8th draft.
+
+// Note that example has a server and client together - normally they'd be in
+// separate files, likely on separate devices.
+
+// ---
+// `server.ts`
+// ----
+
+import { default as express } from 'express'
+import { rateLimit } from 'express-rate-limit'
+
+// Create a rate-limited server.
+const app = express()
+app.use(
+	rateLimit({
+		limit: 8,
+		windowMs: 2 * 60 * 1000, // 2 minute windows.
+		legacyHeaders: false, // Disable the `X-RateLimit-*` headers.
+		standardHeaders: 'draft-8', // Use the combined `RateLimit` header.
+	}),
+	rateLimit({
+		limit: 45,
+		windowMs: 5 * 60 * 60 * 1000, // 2 hour windows.
+		legacyHeaders: false, // Disable the `X-RateLimit-*` headers.
+		standardHeaders: 'draft-8', // Use the combined `RateLimit` header.
+	}),
+)
+
+// Register routes, and start the server.
+app.get('/', (req, res) => res.send('Hallo there!'))
+const { port, server } = await new Promise((resolve) => {
+	const server = app.listen(0, () =>
+		resolve({ port: server.address().port, server }),
+	)
+})
+
+// ---
+// `client.ts`
+// ---
+
+import { getRateLimits } from 'ratelimit-header-parser'
+
+// Fetch a response from the server.
+const response = await fetch(`http://localhost:${port}`)
+
+console.log('`RateLimit` header content:', response.headers.get('RateLimit'))
+console.log(
+	'`RateLimit-Policy` header content:',
+	response.headers.get('RateLimit-Policy'),
+)
+// > `RateLimit` header content: limit=5, remaining=4, reset=60
+console.log(
+	'parsed rate limit info:',
+	JSON.stringify(getRateLimits(response), undefined, 2),
+)
+// > parsed rate limit info: { limit: 5, used: 1, remaining: 4, reset: 2023-08-25T04:41:31.546Z }
+
+// Cleanup the server.
+server.close()

examples/node/http-get.ts

@@ -6,7 +6,10 @@ import { getRateLimits } from 'ratelimit-header-parser'
 
 // Make a GET request to the Imgur API.
 https.get('https://api.imgur.com/post/v1/posts/t/aww', (response) => {
-	console.log('imgur ratelimit:', getRateLimits(response))
+	console.log(
+		'imgur ratelimit:',
+		JSON.stringify(getRateLimits(response), undefined, 2),
+	)
 	return response.resume()
 })
 

examples/node/native-fetch.ts

@@ -5,6 +5,9 @@ import { getRateLimit } from 'ratelimit-header-parser'
 
 // Make a GET request to the GitHub API.
 const response = await fetch('https://api.github.com/orgs/express-rate-limit')
-console.log('github ratelimit:', getRateLimit(response))
+console.log(
+	'github ratelimit:',
+	JSON.stringify(getRateLimit(response), undefined, 2),
+)
 
 // > github ratelimit: { limit: 60, used: 1, remaining: 59, reset: 2023-08-25T04:16:48.000Z }

examples/node/node-fetch.ts

@@ -6,6 +6,9 @@ import { getRateLimit } from 'ratelimit-header-parser'
 
 // Make a GET request to the GitHub API.
 const response = await fetch('https://api.github.com/orgs/express-rate-limit')
-console.log('github ratelimit:', getRateLimit(response))
+console.log(
+	'github ratelimit:',
+	JSON.stringify(getRateLimit(response), undefined, 2),
+)
 
 // > github ratelimit: { limit: 60, used: 1, remaining: 59, reset: 2023-08-25T04:16:48.000Z }