Logo for jsDocs.io

env-cmd

  • Version 11.0.0
  • Published
  • 55.2 kB
  • 3 dependencies
  • MIT license

Install

npm i env-cmd
yarn add env-cmd
pnpm add env-cmd

Overview

Executes a command using the environment variables in an env file

Index

Variables

Functions

Interfaces

Type Aliases

Variables

variable GetEnvVars

const GetEnvVars: (options?: GetEnvVarOptions) => Promise<Environment>;

    Functions

    function CLI

    CLI: (args: string[]) => Promise<Environment>;

    • Executes env - cmd using command line arguments

      Parameter args

      Command line argument to pass in ['-f', './.env']

      Returns

      {Promise}

    function EnvCmd

    EnvCmd: ({
        command,
        commandArgs,
        envFile,
        rc,
        options,
    }: EnvCmdOptions) => Promise<Environment>;

    • The main env-cmd program. This will spawn a new process and run the given command using various environment file solutions.

      Parameter

      {EnvCmdOptions} { command, commandArgs, envFile, rc, options }

      Returns

      {Promise} Returns an object containing [environment variable name]: value

    Interfaces

    interface EnvCmdOptions

    interface EnvCmdOptions extends GetEnvVarOptions {}

      property command

      command: string;

        property commandArgs

        commandArgs: string[];

          property options

          options?: {
              expandEnvs?: boolean;
              recursive?: boolean;
              noOverride?: boolean;
              silent?: boolean;
              useShell?: boolean;
              verbose?: boolean;
          };

            interface EnvFileOptions

            interface EnvFileOptions {}

              property fallback

              fallback?: boolean;

                property filePath

                filePath?: string;

                  interface GetEnvVarOptions

                  interface GetEnvVarOptions {}

                    property envFile

                    envFile?: EnvFileOptions;

                      property rc

                      rc?: RCFileOptions;

                        property verbose

                        verbose?: boolean;

                          interface RCFileOptions

                          interface RCFileOptions {}

                            property environments

                            environments: string[];

                              property filePath

                              filePath?: string;

                                Type Aliases

                                type CommanderOptions

                                type CommanderOptions = Command<
                                    [],
                                    {
                                        environments?: true | string[];
                                        expandEnvs?: boolean;
                                        recursive?: boolean;
                                        fallback?: boolean;
                                        file?: true | string;
                                        override?: boolean;
                                        silent?: boolean;
                                        useShell?: boolean;
                                        verbose?: boolean;
                                    }
                                >;

                                  type Environment

                                  type Environment = Partial<Record<string, string>>;

                                    type RCEnvironment

                                    type RCEnvironment = Partial<Record<string, Environment>>;

                                      Package Files (4)

                                      Dependencies (3)

                                      Dev Dependencies (19)

                                      Peer Dependencies (0)

                                      No peer dependencies.

                                      Badge

                                      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/env-cmd.

                                      • Markdown
                                        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/env-cmd)
                                      • HTML
                                        <a href="https://www.jsdocs.io/package/env-cmd"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>