@aofl/server-environment

Helps determine dev, stage, prod environments based on hostname

Usage no npm install needed!

<script type="module">
  import aoflServerEnvironment from 'https://cdn.skypack.dev/@aofl/server-environment';
</script>

README

@aofl/server-environment

Helps determine dev, stage, prod environments based on hostname.

Api Documentation

Examples

Installation

npm i -S @aofl/server-environment

Usage

import {getServerEnvironment, environmentTypeEnumerate} from '@aofl/server-environment';

const env = getServerEnvironment(/localhost/, /^stage\./);
const debugMode = (env === environmentTypeEnumerate.DEV);

Methods

getServerEnvironment

Takes a devRegex and a stageRegex and tests them against hostname. Returns 'production' if the regexes do not capture any results from hostname.

Name Type Description
devRegex RegExp
stageRegex RegEx

Constants

environmentTypeEnumerate

Key Value
DEV development
STAGE stage
PROD production