Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebEnvironment

Utility API to verify which environment is the web application running.

The utility will check initially for the existence of a system property under the name vertx.mode, if there is no such property then it will look under the environment variables under the name VERTX_MODE.

This value will be then used when the API is invoked. By itself this utility will not affect the behavior of your application, however you can use it to simplify your handlers, e.g.:

When the development mode is active you can log more information or disable caches.

Hierarchy

  • WebEnvironment

Index

Properties

Static Readonly ENV_VARIABLE_NAME

ENV_VARIABLE_NAME: string

Static Readonly SYSTEM_PROPERTY_NAME

SYSTEM_PROPERTY_NAME: string

Methods

Static development

  • development(): boolean
  • Will return true if the mode is not null and equals ignoring case the string "dev"

    Returns boolean

Static mode

  • mode(): string | null
  • The current mode from the system properties with fallback to environment variables

    Returns string | null

Generated using TypeDoc