summaryrefslogtreecommitdiff
path: root/docs/configuration/rate-limiting.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/configuration/rate-limiting.md')
-rw-r--r--docs/configuration/rate-limiting.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/configuration/rate-limiting.md b/docs/configuration/rate-limiting.md
new file mode 100644
index 0000000..c3014d1
--- /dev/null
+++ b/docs/configuration/rate-limiting.md
@@ -0,0 +1,14 @@
+# Rate Limiting
+
+The `rate` config option allows you to specify at which rate the scraper should send out requests. The rate is measured in _Requests per Second_ (RPS) and can be set as a whole or decimal number to account for shorter and longer request intervals.
+
+When no `rate` is specified, rate limiting is disabled and the scraper will send out requests as fast as it can.
+
+Example:
+
+```javascript
+export const options = {
+ url: "http://example.com/",
+ rate: 50,
+};
+```