Class Runtime

The Runtime() class setup and regulate the necessary environment configurations.
Some process environment can be set in order to update runtime options.

.RUNTIME_MODE = 'DEV' | 'PROD' // Runtime mode

.CUSTOM_ENV_PATH = '/path/to/.env' // Custom .env path

.SKIP_YES_NO = 'yes' | 'no' // Skip every question

Hierarchy

  • Runtime

Constructors

constructor

Properties

MODE debug

Methods

runSnippet

Constructors

constructor

  • The Runtime() class setup and regulate the necessary environment configurations.

    Parameters

    • MODE: "PROD" | "DEV"

      Runtime mode DEV for development or PROD for production.

    Returns Runtime

Properties

Readonly MODE

MODE: "PROD" | "DEV"

Private debug

debug: Debugger = ...

Methods

runSnippet

  • The runSnippet() method run the provided snippet under the runtime's environment.

    Parameters

    • snippet: ((debug: Debugger) => void | Promise<void>)

      A snippet function that will be executed in the runtime.

        • (debug: Debugger): void | Promise<void>

        • Parameters

          Returns void | Promise<void>

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc