diff options
| author | Philipp Tanlak <philipp.tanlak@gmail.com> | 2023-10-19 17:54:18 +0200 |
|---|---|---|
| committer | Philipp Tanlak <philipp.tanlak@gmail.com> | 2023-10-19 18:21:58 +0200 |
| commit | 0daefa86b400efe08245f4f2a386f7341b76b24e (patch) | |
| tree | 60d743bb9734a9d7f46701a5ac9026650a330d49 /docs/configuration/rate-limiting.md | |
| parent | 03b3be0c3bbc70584e8988e1810dc28eacf4521f (diff) | |
docs: Add documentationv0.3.0
Diffstat (limited to 'docs/configuration/rate-limiting.md')
| -rw-r--r-- | docs/configuration/rate-limiting.md | 14 |
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, +}; +``` |