Logo for jsDocs.io

@aws-sdk/node-config-provider

  • Version 3.295.0
  • Published
  • 22.9 kB
  • 4 dependencies
  • Apache-2.0 license

Install

npm i @aws-sdk/node-config-provider
yarn add @aws-sdk/node-config-provider
pnpm add @aws-sdk/node-config-provider

Overview

Load config default values from ini config files and environmental variable

Index

Functions

Interfaces

Type Aliases

Functions

function loadConfig

loadConfig: <T = string>(
    {
        environmentVariableSelector,
        configFileSelector,
        default: defaultValue,
    }: LoadedConfigSelectors<T>,
    configuration?: LocalConfigOptions
) => Provider<T>;

    Interfaces

    interface LoadedConfigSelectors

    interface LoadedConfigSelectors<T> {}

      property configFileSelector

      configFileSelector: GetterFromConfig<T>;

      • A getter function getting config values associated with the inferred profile from shared INI files

      property default

      default: FromStaticConfig<T>;

      • Default value or getter

      property environmentVariableSelector

      environmentVariableSelector: GetterFromEnv<T>;

      • A getter function getting the config values from all the environment variables.

      Type Aliases

      type LocalConfigOptions

      type LocalConfigOptions = SharedConfigInit;

        Package Files (2)

        Dependencies (4)

        Dev Dependencies (7)

        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/@aws-sdk/node-config-provider.

        • Markdown
          [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@aws-sdk/node-config-provider)
        • HTML
          <a href="https://www.jsdocs.io/package/@aws-sdk/node-config-provider"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>