@adobe/aio-lib-env

Adobe I/O lib for determining dev environment

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@adobe/aio-lib-env
102.0.0a month ago2 years agoMinified + gzip package size for @adobe/aio-lib-env in KB

Readme


Version Downloads/week Node.js CI License Codecov Coverage
Adobe I/O Env Lib
This is a helper library that is to be used in the Adobe I/O CLI and SDKs to determine the environment to run in, whether prod, or stage.

Installing

$ npm install @adobe/aio-lib-env 

Usage

Determining the Environment
const { 
  getCliEnv, /* function */ 
  setCliEnv, /* function */
  SUPPORTED_ENVS, /* array<string> */
  DEFAULT_ENV, /* string */
  PROD_ENV, /* string */
  STAGE_ENV /* string */
} = require('@adobe/aio-lib-env')

// getCliEnv defaults to PROD_ENV if the global config key is not set, or is set to an unknown env
const env = getCliEnv() 
// do something based on the env - switch to prod or stage endpoints, for example

Setting the Environment (.aio)
{
  cli: {
    env: "prod"
  }
}

Setting the Environment (.env)
AIO_CLI_ENV=prod

Setting the Environment (in code)
const { setCliEnv, PROD_ENV, STAGE_ENV } = require('@adobe/aio-lib-env')

setCliEnv(PROD_ENV)
setCliEnv(STAGE_ENV)
setCliEnv('delta-quadrant') // throws Error

Debug Logs

LOG_LEVEL=debug <your_call_here>

Prepend the LOG_LEVEL environment variable and debug value to the call that invokes your function, on the command line. This should output a lot of debug data for your SDK calls.

Contributing

Contributions are welcome! Read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.