From 8334e2b728ce3275415444e047e10fa97d9e9bd7 Mon Sep 17 00:00:00 2001 From: claabs Date: Sun, 16 Jun 2024 02:02:02 +0000 Subject: [PATCH] deploy: cae1c4e236071c65647206947d1cda781c3e310b --- classes/AccountConfig.html | 6 ++--- classes/AppConfig.html | 46 ++++++++++++++++---------------- classes/AppriseConfig.html | 6 ++--- classes/BarkConfig.html | 10 +++---- classes/DiscordConfig.html | 8 +++--- classes/EmailAuthConfig.html | 6 ++--- classes/EmailConfig.html | 16 +++++------ classes/GotifyConfig.html | 8 +++--- classes/HomeassistantConfig.html | 10 +++---- classes/LocalConfig.html | 4 +-- classes/NtfyConfig.html | 8 +++--- classes/PushoverConfig.html | 6 ++--- classes/SlackConfig.html | 6 ++--- classes/TelegramConfig.html | 8 +++--- classes/WebPortalConfig.html | 10 +++---- classes/WebhookConfig.html | 6 ++--- enums/LogLevel.html | 4 +-- enums/NotificationType.html | 4 +-- enums/SearchStrategy.html | 8 +++--- types/AnyNotifierConfig.html | 2 +- variables/CONFIG_DIR.html | 2 +- 21 files changed, 92 insertions(+), 92 deletions(-) diff --git a/classes/AccountConfig.html b/classes/AccountConfig.html index 42952e3..d9eb912 100644 --- a/classes/AccountConfig.html +++ b/classes/AccountConfig.html @@ -1,9 +1,9 @@ -AccountConfig | epicgames-freegames-node

Class AccountConfig

Properties

email +AccountConfig | epicgames-freegames-node

Class AccountConfig

Properties

email notifiers?

Properties

email

email: string

Epic Games login email

Example

example@gmail.com

Env

EMAIL

-

Optional notifiers

notifiers?: AnyNotifierConfig[]

Notification options for just this account. This overrides any global notification configs.

+

Optional notifiers

notifiers?: AnyNotifierConfig[]

Notification options for just this account. This overrides any global notification configs.

You may configure multiple notifiers, and they will all be triggered simultaneously.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/AppConfig.html b/classes/AppConfig.html index 4c26079..f28ec93 100644 --- a/classes/AppConfig.html +++ b/classes/AppConfig.html @@ -43,7 +43,7 @@ }, ], } -```

Properties

accountConcurrency +```

Properties

accountConcurrency accounts blacklistedGames browserLaunchRetryAttempts @@ -72,24 +72,24 @@

Default

3

Env

ACCOUNT_CONCURRENCY

-

accounts

accounts: AccountConfig[]

A list of accounts to work with

-

blacklistedGames

blacklistedGames: string[] = []

A list of excluded game titles to skip during processing.

+

accounts

accounts: AccountConfig[]

A list of accounts to work with

+

blacklistedGames

blacklistedGames: string[] = []

A list of excluded game titles to skip during processing.

Example

['Gigabash Demo', 'Another Blacklisted Game']

Env

BLACKLISTED_GAMES (comma separated)

-

browserLaunchRetryAttempts

browserLaunchRetryAttempts: number = ...

How many times to attempt retry attempts to launch a browser after it times out

+

browserLaunchRetryAttempts

browserLaunchRetryAttempts: number = ...

How many times to attempt retry attempts to launch a browser after it times out

Example

2

Default

5

Env

BROWSER_LAUNCH_RETRY_ATTEMPTS

-

browserLaunchTimeout

browserLaunchTimeout: number = ...

In seconds, how long before a stuck Chromium process times out and gets restarted

+

browserLaunchTimeout

browserLaunchTimeout: number = ...

In seconds, how long before a stuck Chromium process times out and gets restarted

Example

30

Default

15

Env

BROWSER_LAUNCH_TIMEOUT

-

browserNavigationTimeout

browserNavigationTimeout: number = ...

How long in milliseconds the browser navigation will wait before timing out. +

browserNavigationTimeout

browserNavigationTimeout: number = ...

How long in milliseconds the browser navigation will wait before timing out. 0 disables timeout (not recommended). See: https://github.com/puppeteer/puppeteer/blob/main/docs/api.md#pagesetdefaulttimeouttimeout

Example

120000
@@ -97,7 +97,7 @@ 
Env
BROWSER_LAUNCH_TIMEOUT

 
Default
30000
 

 
Env
BROWSER_NAVIGATION_TIMEOUT

-

countryCode

countryCode: undefined | string = process.env.COUNTRY_CODE

The 2 character country code associated with your account. +

countryCode

countryCode: undefined | string = process.env.COUNTRY_CODE

The 2 character country code associated with your account. Used when determining if a game is blacklisted for your account. Commonly blacklisted countries: "MO","HK","RU","BY","CN"

Example

RU
@@ -105,7 +105,7 @@ 
Env
BROWSER_NAVIGATION_TIMEOUT

 
Default
blacklisting is not checked
 

 
Env
COUNTRY_CODE

-

cronSchedule

cronSchedule: string = ...

Cron string of when to run the process. +

cronSchedule

cronSchedule: string = ...

Cron string of when to run the process. It is recommended to run every 6 hours, otherwise the refresh tokens will expire after 8 hours and a new login will be prompted every run. If you want the check to occur immediately after the new free game is released, you can offset the cron schedule. For example in a timezone where the free games release at 11:00am: 0 5,11,17,23 * * *

Example

0 5,11,17,23 * * *
@@ -113,7 +113,7 @@ 
Env
COUNTRY_CODE

 
Default
0 0,6,12,18 * * * (every six hours)
 

 
Env
CRON_SCHEDULE

-

deviceAuthClientId

deviceAuthClientId: string = ...

The Epic Games application client ID used for device code authorization to check your account's ownership of a game +

deviceAuthClientId

deviceAuthClientId: string = ...

The Epic Games application client ID used for device code authorization to check your account's ownership of a game List of available clients here.

Example

b070f20729f84693b5d621c904fc5bc2 (Diesel - Dauntless)
@@ -122,13 +122,13 @@

Example

e645e4b9629841
 
Default
98f7e42c2e3a4f86a74eb43fbb41ed39 (fortniteNewSwitchGameClient client ID)
 

 
Env
DEVICE_AUTH_CLIENT_ID

-

deviceAuthPollRateSeconds

deviceAuthPollRateSeconds: number = ...

After redirecting to a device authorization verification URL, how often the Epic Games API is polled for a successful login.

+

deviceAuthPollRateSeconds

deviceAuthPollRateSeconds: number = ...

After redirecting to a device authorization verification URL, how often the Epic Games API is polled for a successful login.

Example

20

Default

10

Env

DEVICE_AUTH_POLL_RATE_SECONDS

-

deviceAuthSecret

deviceAuthSecret: string = ...

The Epic Games application secret used for device code authorization to check your account's ownership of a game. +

deviceAuthSecret

deviceAuthSecret: string = ...

The Epic Games application secret used for device code authorization to check your account's ownership of a game. List of available clients here.

Example

HG@XE&TGCxEJsgT#&_p2]=aRo#~>=>+c6PhR)zXP (Diesel - Dauntless)
@@ -137,51 +137,51 @@

Example

d03089fdDefault
0a2449a2-001a-451e-afec-3e812901c4d7 (fortniteNewSwitchGameClient client secret)
 

 
Env
DEVICE_AUTH_SECRET

-

errorsDir

errorsDir: string = ...

The full path where the browser automation error screenshots will be output

+

errorsDir

errorsDir: string = ...

The full path where the browser automation error screenshots will be output

Example

/errors

Default

${CONFIG_DIR}/errors

Env

ERRORS_DIR

-

intervalTime

intervalTime: number = ...

The delay interval between runs of each account in seconds. (Only effective when multiple accounts are configured)

+

intervalTime

intervalTime: number = ...

The delay interval between runs of each account in seconds. (Only effective when multiple accounts are configured)

Example

30

Default

60

Env

INTERVAL_TIME

-

logLevel

logLevel: string = ...

Log level in lower case. Can be [silent, error, warn, info, debug, trace]

+

logLevel

logLevel: string = ...

Log level in lower case. Can be [silent, error, warn, info, debug, trace]

Example

debug

Default

info

Env

LOG_LEVEL

-

Optional notifiers

notifiers?: AnyNotifierConfig[]

Global default notification configuration.

+

Optional notifiers

notifiers?: AnyNotifierConfig[]

Global default notification configuration.

You may configure multiple notifiers, and they will all be triggered simultaneously.

-

runOnStartup

runOnStartup: boolean = ...

If true, the process will run on startup in addition to the scheduled time.

+

runOnStartup

runOnStartup: boolean = ...

If true, the process will run on startup in addition to the scheduled time.

Example

true

Default

false

Env

RUN_ON_STARTUP

-

runOnce

runOnce: boolean = ...

If true, don't schedule runs. Use with RUN_ON_STARTUP to run once and shutdown.

+

runOnce

runOnce: boolean = ...

If true, don't schedule runs. Use with RUN_ON_STARTUP to run once and shutdown.

Example

true

Default

false

Env

RUN_ONCE

-

searchStrategy

searchStrategy: string = ...

The search criteria for finding free games. Either the weekly promotion, and free promotion, or all free products.

+

searchStrategy

searchStrategy: string = ...

The search criteria for finding free games. Either the weekly promotion, and free promotion, or all free products.

Example

weekly

Default

all

Env

SEARCH_STRATEGY

-

skipVersionCheck

skipVersionCheck: boolean = ...

Skip the call to api.github.com that checks for the latest version on launch

+

skipVersionCheck

skipVersionCheck: boolean = ...

Skip the call to api.github.com that checks for the latest version on launch

Example

true

Default

false

Env

SKIP_VERSION_CHECK

-

testNotifiers

testNotifiers: boolean = ...

When true, the process will send test notifications with a test redirect to example.com for all configured accounts. +

testNotifiers

testNotifiers: boolean = ...

When true, the process will send test notifications with a test redirect to example.com for all configured accounts. Be sure to disable this after a successful test. This test will block normal operation until the test link is accessed by one account. The test page can only be used once.

Example

true
@@ -189,11 +189,11 @@ 
Env
SKIP_VERSION_CHECK

 
Default
false
 

 
Env
TEST_NOTIFIERS

-

timezone

timezone: string = ...

TZ name from this list: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List

+

timezone

timezone: string = ...

TZ name from this list: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List

Example

America/Chicago

Default

UTC

Env

TZ

-

Optional webPortalConfig

webPortalConfig?: WebPortalConfig

Web server configurations for the remote web portal

-

Methods

getMsUntilNextRun

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Optional webPortalConfig

webPortalConfig?: WebPortalConfig

Web server configurations for the remote web portal

+

Methods

getMsUntilNextRun

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/AppriseConfig.html b/classes/AppriseConfig.html index 79802e2..bfe2f78 100644 --- a/classes/AppriseConfig.html +++ b/classes/AppriseConfig.html @@ -1,16 +1,16 @@ AppriseConfig | epicgames-freegames-node

Class AppriseConfig

Sends a notification to many services via Apprise API. Supports 70+ different notification services.

-

Hierarchy

  • NotifierConfig
    • AppriseConfig

Properties

apiUrl +

Hierarchy

  • NotifierConfig
    • AppriseConfig

Properties

apiUrl type urls?

Properties

apiUrl

apiUrl: string

The base URL of your Apprise instance

Example

http://localhost:8000

Env

APPRISE_API

-

type

type: NotificationType

Optional urls

urls?: string

One or more URLs identifying where the notification should be sent to. +

type

type: NotificationType

Optional urls

urls?: string

One or more URLs identifying where the notification should be sent to. If this field isn't specified then it automatically assumes the settings.APPRISE_STATELESS_URLS in your Apprise instance. More details: https://github.com/caronc/apprise-api#stateless-solution

Example

mailto://user:pass@gmail.com

Env

APPRISE_URLS

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/BarkConfig.html b/classes/BarkConfig.html index 5754136..f876de9 100644 --- a/classes/BarkConfig.html +++ b/classes/BarkConfig.html @@ -1,6 +1,6 @@ BarkConfig | epicgames-freegames-node

Class BarkConfig

Send a notification to the Bark iOS app https://github.com/Finb/Bark

-

Hierarchy

  • NotifierConfig
    • BarkConfig

Properties

apiUrl +

Hierarchy

  • NotifierConfig
    • BarkConfig

Properties

apiUrl group key title @@ -9,14 +9,14 @@

Default

https://api.day.app

Env

BARK_API_URL

-

group

group: string = 'epicgames-freegames-node'

Bark group

+

group

group: string = 'epicgames-freegames-node'

Bark group

Default

epicgames-freegames-node

Env

BARK_GROUP

-

key

key: string

Bark key

+

key

key: string

Bark key

Env

BARK_KEY

-

title

title: string = 'epicgames-freegames-node'

Bark title

+

title

title: string = 'epicgames-freegames-node'

Bark title

Default

epicgames-freegames-node

Env

BARK_TITLE

-

type

type: NotificationType

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

type

type: NotificationType

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/DiscordConfig.html b/classes/DiscordConfig.html index 2327af1..36ee113 100644 --- a/classes/DiscordConfig.html +++ b/classes/DiscordConfig.html @@ -1,5 +1,5 @@ DiscordConfig | epicgames-freegames-node

Class DiscordConfig

Sends a message to a server text channel using a webhook

-

Hierarchy

  • NotifierConfig
    • DiscordConfig

Properties

mentionedRoles +

Hierarchy

  • NotifierConfig
    • DiscordConfig

Properties

mentionedRoles mentionedUsers type webhookUrl @@ -8,14 +8,14 @@

Example

["734548250895319070", "734548250895319071"]

Env

DISCORD_MENTIONED_ROLES (comma separated)

-

mentionedUsers

mentionedUsers: string[]

A list of Discord user IDs to ping when posting the message. The IDs must be strings wrapped in quotes. +

mentionedUsers

mentionedUsers: string[]

A list of Discord user IDs to ping when posting the message. The IDs must be strings wrapped in quotes. How to get a user ID: https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-

Example

["914360712086843432", "914360712086843433"]

Env

DISCORD_MENTIONED_USERS (comma separated)

-

type

type: NotificationType

webhookUrl

webhookUrl: string

Discord channel webhook URL. +

type

type: NotificationType

webhookUrl

webhookUrl: string

Discord channel webhook URL. Guide: https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks

Example

https://discord.com/api/webhooks/123456789123456789/A-abcdefghijklmn-abcdefghijklmnopqrst12345678-abcdefghijklmnop123456

Env

DISCORD_WEBHOOK

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/EmailAuthConfig.html b/classes/EmailAuthConfig.html index 6d7c2ad..3d76326 100644 --- a/classes/EmailAuthConfig.html +++ b/classes/EmailAuthConfig.html @@ -1,11 +1,11 @@ -EmailAuthConfig | epicgames-freegames-node

Class EmailAuthConfig

Properties

pass +EmailAuthConfig | epicgames-freegames-node

Class EmailAuthConfig

Properties

pass user

Properties

pass

pass: string

The SMTP password (if necessary)

Example

abc123

Env

SMTP_PASSWORD

-

user

user: string

The SMTP username (if necessary)

+

user

user: string

The SMTP username (if necessary)

Example

hello@gmail.com

Env

SMTP_USERNAME

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/EmailConfig.html b/classes/EmailConfig.html index c827471..8d1effe 100644 --- a/classes/EmailConfig.html +++ b/classes/EmailConfig.html @@ -1,7 +1,7 @@ EmailConfig | epicgames-freegames-node

Class EmailConfig

Configuration for sending notifications via email.

Example Gmail settings.

If you have 2FA setup for your Google account, you'll need to create an app password

-

Hierarchy

  • NotifierConfig
    • EmailConfig

Properties

auth? +

Hierarchy

  • NotifierConfig
    • EmailConfig

Properties

auth? emailRecipientAddress emailSenderAddress emailSenderName @@ -10,30 +10,30 @@ smtpPort type

Properties

Optional auth

auth?: EmailAuthConfig

Auth settings for SMTP

-

emailRecipientAddress

emailRecipientAddress: string

The recipient of the email (can be your email address)

+

emailRecipientAddress

emailRecipientAddress: string

The recipient of the email (can be your email address)

Example

hello@gmail.com

Env

EMAIL_RECIPIENT_ADDRESS

-

emailSenderAddress

emailSenderAddress: string

The sender of the email you will recieve (can be your email address)

+

emailSenderAddress

emailSenderAddress: string

The sender of the email you will recieve (can be your email address)

Example

hello@gmail.com

Env

EMAIL_SENDER_ADDRESS

-

emailSenderName

emailSenderName: string

The name of the email sender

+

emailSenderName

emailSenderName: string

The name of the email sender

Example

Epic Games Free Games

Env

EMAIL_SENDER_NAME

-

secure

secure: boolean = false

true for SSL (port 465), false for TLS or unsecure

+

secure

secure: boolean = false

true for SSL (port 465), false for TLS or unsecure

Example

true

Default

false

Env

SMTP_SECURE

-

smtpHost

smtpHost: string

The outgoing SMTP host name

+

smtpHost

smtpHost: string

The outgoing SMTP host name

Example

smtp.gmail.com

Env

SMTP_HOST

-

smtpPort

smtpPort: number

The outgoing SMTP port (SSL or TLS, see secure)

+

smtpPort

smtpPort: number

The outgoing SMTP port (SSL or TLS, see secure)

Example

587

Env

SMTP_PORT

-

type

type: NotificationType

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

type

type: NotificationType

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/GotifyConfig.html b/classes/GotifyConfig.html index 2965dac..2d10c00 100644 --- a/classes/GotifyConfig.html +++ b/classes/GotifyConfig.html @@ -1,5 +1,5 @@ GotifyConfig | epicgames-freegames-node

Class GotifyConfig

Sends a message to a self-hosted Gotify server

-

Hierarchy

  • NotifierConfig
    • GotifyConfig

Properties

apiUrl +

Hierarchy

  • NotifierConfig
    • GotifyConfig

Properties

apiUrl priority token type @@ -7,14 +7,14 @@

Example

http://gotify.net

Env

GOTIFY_API_URL

-

priority

priority: number = 5

The priority level sent with the message.

+

priority

priority: number = 5

The priority level sent with the message.

Example

7

Default

5

Env

GOTIFY_PRIORITY

-

token

token: string

On the Gotify web UI, Apps > Create Application > reveal the token

+

token

token: string

On the Gotify web UI, Apps > Create Application > reveal the token

Example

SnL-wAvmfo_QT

Env

GOTIFY_TOKEN

-

type

type: NotificationType

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

type

type: NotificationType

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/HomeassistantConfig.html b/classes/HomeassistantConfig.html index a41542d..d317040 100644 --- a/classes/HomeassistantConfig.html +++ b/classes/HomeassistantConfig.html @@ -1,5 +1,5 @@ HomeassistantConfig | epicgames-freegames-node

Class HomeassistantConfig

Sends a homeassistant notification

-

Hierarchy

  • NotifierConfig
    • HomeassistantConfig

Properties

customData +

Hierarchy

  • NotifierConfig
    • HomeassistantConfig

Properties

customData instance notifyservice token @@ -8,13 +8,13 @@

Example

{ "parse_mode": "html" }

Env

HOMEASSISTANT_CUSTOM_DATA (stringified JSON)

-

instance

instance: string

Example

https://homeassistant.example.com
+

instance

instance: string

Example

https://homeassistant.example.com

Env

HOMEASSISTANT_INSTANCE

-

notifyservice

notifyservice: string

Example

mobile_app_smartphone_name
+

notifyservice

notifyservice: string

Example

mobile_app_smartphone_name

Env

HOMEASSISTANT_NOTIFYSERVICE

-

token

token: string

Example

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
+

token

token: string

Example

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Env

HOMEASSISTANT_LONG_LIVED_ACCESS_TOKEN

-

type

type: NotificationType

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

type

type: NotificationType

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/LocalConfig.html b/classes/LocalConfig.html index a00fa0e..e5cc56b 100644 --- a/classes/LocalConfig.html +++ b/classes/LocalConfig.html @@ -1,3 +1,3 @@ LocalConfig | epicgames-freegames-node

Class LocalConfig

For local development only. This just opens the notified URL in your default browser.

-

Hierarchy

  • NotifierConfig
    • LocalConfig

Properties

type -

Properties

type

type: NotificationType

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • NotifierConfig
    • LocalConfig

Properties

type +

Properties

type

type: NotificationType

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/NtfyConfig.html b/classes/NtfyConfig.html index afdfea8..6c31d39 100644 --- a/classes/NtfyConfig.html +++ b/classes/NtfyConfig.html @@ -1,5 +1,5 @@ NtfyConfig | epicgames-freegames-node

Class NtfyConfig

Sends a ntfy message using webhook

-

Hierarchy

  • NotifierConfig
    • NtfyConfig

Properties

priority +

Hierarchy

  • NotifierConfig
    • NtfyConfig

Properties

priority token type webhookUrl @@ -8,14 +8,14 @@

Example

urgent

Env

NTFY_PRIORITY

-

token

token: string

ntfy channel token. +

token

token: string

ntfy channel token. Guide: https://docs.ntfy.sh/config/#access-tokens

Example

tk_yourtoken

Env

NTFY_TOKEN

-

type

type: NotificationType

webhookUrl

webhookUrl: string

ntfy channel webhook URL. +

type

type: NotificationType

webhookUrl

webhookUrl: string

ntfy channel webhook URL. Guide: https://docs.ntfy.sh/publish/

Example

https://ntfy.sh/mytopic

Env

NTFY_WEBHOOK

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/PushoverConfig.html b/classes/PushoverConfig.html index f352135..a9b5e4d 100644 --- a/classes/PushoverConfig.html +++ b/classes/PushoverConfig.html @@ -1,12 +1,12 @@ PushoverConfig | epicgames-freegames-node

Class PushoverConfig

Sends a pushover message

-

Hierarchy

  • NotifierConfig
    • PushoverConfig

Properties

token +

Hierarchy

  • NotifierConfig
    • PushoverConfig

Properties

token type userKey

Properties

token

token: string

Guide: https://pushover.net/apps/build

Example

a172fyyl9gw99p2xi16tq8hnib48p2

Env

PUSHOVER_TOKEN

-

type

type: NotificationType

userKey

userKey: string

Example

uvgidym7l5ggpwu2r8i1oy6diaapll
+

type

type: NotificationType

userKey

userKey: string

Example

uvgidym7l5ggpwu2r8i1oy6diaapll

Env

PUSHOVER_USER_ID

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/SlackConfig.html b/classes/SlackConfig.html index efbade1..a8b18eb 100644 --- a/classes/SlackConfig.html +++ b/classes/SlackConfig.html @@ -1,9 +1,9 @@ SlackConfig | epicgames-freegames-node

Class SlackConfig

Sends a slack message using webhook

-

Hierarchy

  • NotifierConfig
    • SlackConfig

Properties

type +

Hierarchy

  • NotifierConfig
    • SlackConfig

Properties

type webhookUrl -

Properties

type

type: NotificationType

webhookUrl

webhookUrl: string

slack channel webhook URL. +

Properties

type

type: NotificationType

webhookUrl

webhookUrl: string

slack channel webhook URL. Guide: https://api.slack.com/messaging/webhooks

Example

https://hooks.slack.com/services/T22CE80ABCD/CE3AWABCDEFG/F8jdewBb4fmDDx6fV0abcdefg

Env

SLACK_WEBHOOK

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/TelegramConfig.html b/classes/TelegramConfig.html index 82f8bb0..f5c55b0 100644 --- a/classes/TelegramConfig.html +++ b/classes/TelegramConfig.html @@ -1,5 +1,5 @@ TelegramConfig | epicgames-freegames-node

Class TelegramConfig

Sends a message to a group chat using a bot you must set up yourself

-

Hierarchy

  • NotifierConfig
    • TelegramConfig

Properties

apiUrl +

Hierarchy

  • NotifierConfig
    • TelegramConfig

Properties

apiUrl chatId token type @@ -7,14 +7,14 @@

Default

https://api.telegram.org

Env

TELEGRAM_API_URL

-

chatId

chatId: string

Unique identifier for the target chat or username of the target channel

+

chatId

chatId: string

Unique identifier for the target chat or username of the target channel

Example

-987654321

Example

Channelusername

Env

TELEGRAM_CHAT_ID

-

token

token: string

Telegram bot token obtained here: https://core.telegram.org/bots#3-how-do-i-create-a-bot

+

token

token: string

Telegram bot token obtained here: https://core.telegram.org/bots#3-how-do-i-create-a-bot

Example

644739147:AAGMPo-Jz3mKRnHRTnrPEDi7jUF1vqNOD5k

Env

TELEGRAM_TOKEN

-

type

type: NotificationType

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

type

type: NotificationType

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/WebPortalConfig.html b/classes/WebPortalConfig.html index da9b841..1179603 100644 --- a/classes/WebPortalConfig.html +++ b/classes/WebPortalConfig.html @@ -1,4 +1,4 @@ -WebPortalConfig | epicgames-freegames-node

Class WebPortalConfig

Properties

baseUrl? +WebPortalConfig | epicgames-freegames-node

Class WebPortalConfig

Properties

baseUrl? listenOpts? localtunnel? serverOpts? @@ -8,15 +8,15 @@

Default

http://localhost:3000

Env

BASE_URL

-

Optional listenOpts

listenOpts?: ListenOptions

Node Net.listen options: https://nodejs.org/api/net.html#net_server_listen_options_callback

+

Optional listenOpts

listenOpts?: ListenOptions

Node Net.listen options: https://nodejs.org/api/net.html#net_server_listen_options_callback

Default

{ port: 3000 }

Env

SERVER_PORT (for {port: SERVER_PORT} only)

-

Optional localtunnel

localtunnel?: boolean = ...

If true, provide a remotely accessible web address via localtunnel without the need to port forward or reverse proxy

+

Optional localtunnel

localtunnel?: boolean = ...

If true, provide a remotely accessible web address via localtunnel without the need to port forward or reverse proxy

Example

true

Default

false

Env

LOCAL_TUNNEL

-

Optional serverOpts

serverOpts?: ServerOptions

Node HTTPS.createServer options: https://nodejs.org/api/https.html#https_https_createserver_options_requestlistener

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Optional serverOpts

serverOpts?: ServerOptions

Node HTTPS.createServer options: https://nodejs.org/api/https.html#https_https_createserver_options_requestlistener

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/WebhookConfig.html b/classes/WebhookConfig.html index 4cd7911..8a06cfa 100644 --- a/classes/WebhookConfig.html +++ b/classes/WebhookConfig.html @@ -1,11 +1,11 @@ WebhookConfig | epicgames-freegames-node

Class WebhookConfig

Sends a POST request with the notification contents in the body to a webhook URL

-

Hierarchy

  • NotifierConfig
    • WebhookConfig

Properties

headers +

Hierarchy

  • NotifierConfig
    • WebhookConfig

Properties

headers type url

Properties

headers

headers: undefined | Record<string, string>

A key-value pair object to pass into the POST request headers

Example

{ Authorization: "Bearer ABCD" }

Env

WEBHOOK_HEADERS (stringified JSON)

-

type

type: NotificationType

url

url: string

Webhook URL

+

type

type: NotificationType

url

url: string

Webhook URL

Env

WEBHOOK_URL

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/LogLevel.html b/enums/LogLevel.html index 2fcb3c2..57547df 100644 --- a/enums/LogLevel.html +++ b/enums/LogLevel.html @@ -1,7 +1,7 @@ -LogLevel | epicgames-freegames-node

Enumeration LogLevel

Enumeration Members

DEBUG +LogLevel | epicgames-freegames-node

Enumeration LogLevel

Enumeration Members

DEBUG ERROR INFO SILENT TRACE WARN -

Enumeration Members

DEBUG

DEBUG: "debug"

ERROR

ERROR: "error"

INFO

INFO: "info"

SILENT

SILENT: "silent"

TRACE

TRACE: "trace"

WARN

WARN: "warn"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

DEBUG

DEBUG: "debug"

ERROR

ERROR: "error"

INFO

INFO: "info"

SILENT

SILENT: "silent"

TRACE

TRACE: "trace"

WARN

WARN: "warn"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/NotificationType.html b/enums/NotificationType.html index f88f93d..2f06aac 100644 --- a/enums/NotificationType.html +++ b/enums/NotificationType.html @@ -1,4 +1,4 @@ -NotificationType | epicgames-freegames-node

Enumeration NotificationType

Enumeration Members

APPRISE +NotificationType | epicgames-freegames-node

Enumeration NotificationType

Enumeration Members

APPRISE BARK DISCORD EMAIL @@ -10,4 +10,4 @@ SLACK TELEGRAM WEBHOOK -

Enumeration Members

APPRISE

APPRISE: "apprise"

BARK

BARK: "bark"

DISCORD

DISCORD: "discord"

EMAIL

EMAIL: "email"

GOTIFY

GOTIFY: "gotify"

HOMEASSISTANT

HOMEASSISTANT: "homeassistant"

LOCAL

LOCAL: "local"

NTFY

NTFY: "ntfy"

PUSHOVER

PUSHOVER: "pushover"

SLACK

SLACK: "slack"

TELEGRAM

TELEGRAM: "telegram"

WEBHOOK

WEBHOOK: "webhook"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

APPRISE

APPRISE: "apprise"

BARK

BARK: "bark"

DISCORD

DISCORD: "discord"

EMAIL

EMAIL: "email"

GOTIFY

GOTIFY: "gotify"

HOMEASSISTANT

HOMEASSISTANT: "homeassistant"

LOCAL

LOCAL: "local"

NTFY

NTFY: "ntfy"

PUSHOVER

PUSHOVER: "pushover"

SLACK

SLACK: "slack"

TELEGRAM

TELEGRAM: "telegram"

WEBHOOK

WEBHOOK: "webhook"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/SearchStrategy.html b/enums/SearchStrategy.html index 721a878..d9dfd9b 100644 --- a/enums/SearchStrategy.html +++ b/enums/SearchStrategy.html @@ -1,12 +1,12 @@ -SearchStrategy | epicgames-freegames-node

Enumeration SearchStrategy

Enumeration Members

ALL +SearchStrategy | epicgames-freegames-node

Enumeration SearchStrategy

Enumeration Members

ALL PROMOTION WEEKLY

Enumeration Members

ALL

ALL: "all"

Combines the results from weekly and promotion. Continues if at least one of the APIs works.

-

PROMOTION

PROMOTION: "promotion"

Search the entire Epic Games site for any game with a 100% discount. +

PROMOTION

PROMOTION: "promotion"

Search the entire Epic Games site for any game with a 100% discount. This includes the weekly games, plus any uncommon non-weekly temporarily free games. Occasionally excludes the weekly promotion if it's a bundle.

-

WEEKLY

WEEKLY: "weekly"

Redeem only the games defined as a weekly free game at https://www.epicgames.com/store/free-games

+

WEEKLY

WEEKLY: "weekly"

Redeem only the games defined as a weekly free game at https://www.epicgames.com/store/free-games

This uses a different set of APIs from the other search strategies, so it may work in case finding games breaks.

Generally is less stable than promotion due to a more complex lookup method.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/types/AnyNotifierConfig.html b/types/AnyNotifierConfig.html index c8eabd0..b1fdd14 100644 --- a/types/AnyNotifierConfig.html +++ b/types/AnyNotifierConfig.html @@ -1 +1 @@ -AnyNotifierConfig | epicgames-freegames-node

Type alias AnyNotifierConfig

AnyNotifierConfig: EmailConfig | DiscordConfig | LocalConfig | TelegramConfig | AppriseConfig | PushoverConfig | GotifyConfig | SlackConfig | HomeassistantConfig | BarkConfig | NtfyConfig | WebhookConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +AnyNotifierConfig | epicgames-freegames-node

Type alias AnyNotifierConfig

AnyNotifierConfig: EmailConfig | DiscordConfig | LocalConfig | TelegramConfig | AppriseConfig | PushoverConfig | GotifyConfig | SlackConfig | HomeassistantConfig | BarkConfig | NtfyConfig | WebhookConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/CONFIG_DIR.html b/variables/CONFIG_DIR.html index 3c000df..d5871a7 100644 --- a/variables/CONFIG_DIR.html +++ b/variables/CONFIG_DIR.html @@ -1 +1 @@ -CONFIG_DIR | epicgames-freegames-node

Variable CONFIG_DIRConst

CONFIG_DIR: string = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +CONFIG_DIR | epicgames-freegames-node

Variable CONFIG_DIRConst

CONFIG_DIR: string = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file