Skip to content

Commit

Permalink
feat: add docs, add env vars, add country code, deprecate twitch, lin…
Browse files Browse the repository at this point in the history
…ting (#3198)
  • Loading branch information
alanbixby authored Jan 30, 2025
1 parent 4eb678a commit c2ed997
Show file tree
Hide file tree
Showing 190 changed files with 724 additions and 1,546 deletions.
1 change: 1 addition & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"extends": "./node_modules/gts/",
"rules": {
"@typescript-eslint/no-explicit-any": "off",
"prettier/prettier": [
"error",
{
Expand Down
17 changes: 10 additions & 7 deletions docs/reference/application.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,21 @@
| `IN_STOCK_WAIT_TIME` | Time to wait between requests to the same link if it has that card in stock. In seconds, default: `0` |
| `LOG_LEVEL` | [Logging levels](https://github.com/winstonjs/winston#logging-levels). Debugging related, default: `info` |
| `LOW_BANDWIDTH` | Blocks images/fonts to reduce traffic. Disables ad blocker, default: `false` |
| `OPEN_BROWSER` | Toggle for whether or not the browser should open when item is found. Default: `true` |
| `PAGE_BACKOFF_MIN` | Minimum backoff time between retrying requests for the same store when a forbidden response is received. Default: `10000` |
| `PAGE_BACKOFF_MAX` | Maximum backoff time between retrying requests for the same store when a forbidden response is received. Default: `3600000` |
| `NVIDIA_ADD_TO_CART_ATTEMPTS` | Maximum number of attempts add an item to card in the Nvidia storefront, default: `10` |
| `NVIDIA_SESSION_TTL` | Maximum session length on the Nvidia storefront in ms, default: `60000` |
| `OPEN_BROWSER` | Toggle for whether or not the browser should open when item is found, default: `true` |
| `PAGE_BACKOFF_MIN` | Minimum backoff time between retrying requests for the same store when a forbidden response is received, default: `10000` |
| `PAGE_BACKOFF_MAX` | Maximum backoff time between retrying requests for the same store when a forbidden response is received, default: `3600000` |
| `PAGE_SLEEP_MIN` | Minimum sleep time between queries of the same product page. In milliseconds, default: `5000` |
| `PAGE_SLEEP_MAX` | Maximum sleep time between queries of the same product page. In milliseconds, default: `10000` |
| `PAGE_TIMEOUT` | Navigation Timeout in milliseconds. `0` for infinite, default: `30000` |
| `PROXY_PROTOCOL` | Protocol of proxy server, such as `socks5`. Default: `http` |
| `PROXY_PROTOCOL` | Protocol of proxy server, such as `socks5`, default: `http` |
| `PROXY_ADDRESS` | IP Address or fqdn of proxy server |
| `PROXY_PORT` | TCP Port number on which the proxy is listening for connections. Default: `80` |
| `PROXY_PORT` | TCP Port number on which the proxy is listening for connections, default: `80` |
| `RESTART_TIME` | Restarts chrome after defined milliseconds. `0` for never, default: `0` |
| `SCREENSHOT` | Capture screenshot of page if a card is found. Default: `true` |
| `SCREENSHOT_DIR` | The directory for saving the screenshots. Default: `screenshots` |
| `SCREENSHOT` | Capture screenshot of page if a card is found, default: `true` |
| `SCREENSHOT_DIR` | The directory for saving the screenshots, default: `screenshots` |
| `USER_AGENT` | Custom user agent used for requests |
| `WEB_PORT` | Starts a webserver to be able to control the bot while it is running. Setting this value starts this service. |

???+ info
Expand Down
Loading

0 comments on commit c2ed997

Please sign in to comment.