Endo API documentation
    Preparing search index...

    Function makeEnvironmentCaptor

    • makeEnvironmentCaptor provides a mechanism for getting environment variables, if they are needed, and a way to catalog the names of all the environment variables that were captured.

      Parameters

      • aGlobal: any
      • OptionaldropNames: boolean = false

        Defaults to false. If true, don't track names used.

      Returns Readonly<
          {
              environmentOptionsListHas: <T extends string = string>(
                  optionName: string,
                  element: T,
              ) => boolean;
              getCapturedEnvironmentOptionNames: () => readonly string[];
              getEnvironmentOption: (
                  optionName: string,
                  defaultSetting: string,
                  optOtherValues?: string[],
              ) => string;
              getEnvironmentOptionsList: <T extends string = string>(
                  optionName: string,
              ) => T[];
          },
      >