Class AppService

Behaviors to initialize the applications services and execute the synchronization between the docker labels and CloudFlare.

Hierarchy (View Summary)

CronService
- AppService

Index

Constructors

Properties

loggerService stateCron

Accessors

ExecutionFrequencySeconds ServiceName

Methods

initialize job onModuleDestroy start stop

Constructors

constructor

new AppService(
    cloudFlareService: CloudFlareService,
    cloudFlareFactory: CloudFlareFactory,
    dockerService: DockerService,
    configService: ConfigService,
    ddnsService: DdnsService,
    loggerService: ConsoleLoggerService,
): AppService
Parameters
- cloudFlareService: CloudFlareService
- cloudFlareFactory: CloudFlareFactory
- dockerService: DockerService
- configService: ConfigService
- ddnsService: DdnsService
- loggerService: ConsoleLoggerService
Returns AppService
Overrides CronService.constructor
- Defined in src/app.service.ts:63

Properties

`Protected`loggerService

loggerService: ConsoleLoggerService

`Protected`stateCron

stateCron: State = State.Stopped

Accessors

ExecutionFrequencySeconds

get ExecutionFrequencySeconds(): number
Fetches the EXECUTION_FREQUENCY_SECONDS

Returns number
Overrides CronService.ExecutionFrequencySeconds
- Defined in src/app.service.ts:51

ServiceName

get ServiceName(): string
ServiceName used in logging present in CronService

Returns string
Overrides CronService.ServiceName
- Defined in src/app.service.ts:44

Methods

initialize

initialize(): void
Initialize AppService. Initializes CloudFlare and Docker services

Returns void
- Defined in src/app.service.ts:79

job

job(): Promise<void>
Fetches labels from docker. Fetches records from CloudFlare. Computes additions, updates, deletions and unchanged. Adds, Updates and Deletes entries from CloudFlare.

Returns Promise<void>
Overrides CronService.job
- Defined in src/app.service.ts:92

onModuleDestroy

onModuleDestroy(): void
Lifecycle event hook for NestJs: https://docs.nestjs.com/fundamentals/lifecycle-events

Stops the cron job service if the application is shutting down.

Returns void
Inherited from CronService.onModuleDestroy
- Defined in src/cron/cron.service.ts:84

start

start(): Promise<void>
Starts the CRON Job executing. Will execute "synchronise" immediately on invocation and then every x seconds as distated by the environment variable EXECUTION_FREQUENCY_SECONDS.

Returns Promise<void>
Throws
If service is already started
Inherited from CronService.start
- Defined in src/cron/cron.service.ts:45

stop

stop(): void
Stops the CronJob executing.

Returns void
Throws
if CRON job is not running.
Inherited from CronService.stop
- Defined in src/cron/cron.service.ts:68