@scaleway/configuration-loader
TypeScript icon, indicating that this package has built-in type declarations

1.0.3 • Public • Published

Configuration Loader

This package enables you to load a profile from a configuration file or environment variables.

🔗  Important links:

Getting Started

You could hardcode a profile directly within your code:

const profile = {
  accessKey: 'SCWXXXXXXXXXXXXXXXXX',
  secretKey: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
  defaultProjectId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
  defaultRegion: 'fr-par',
  defaultZone: 'fr-par-1',
}

And then use this profile to instantiate the SDK client with const client = createClient(profile).

However, you might prefer to store these variables in either a configuration file (e.g. local testing) or environment variables (e.g. serverless).

In case of configuration file:

import { 
  loadProfileFromConfigurationFile, 
} from '@scaleway/configuration-loader'

const profile = loadProfileFromConfigurationFile()

For a specific profile:

const profile = loadProfileFromEnvironmentValues({ profileName: 'debug' })

In case of environment variables:

import { 
  loadProfileFromEnvironmentValues,
} from '@scaleway/configuration-loader'

const profile = loadProfileFromEnvironmentValues()

Reach us

We love feedback. Feel free to reach us on Scaleway Slack community, we are waiting for you on #opensource.

Readme

Keywords

none

Package Sidebar

Install

npm i @scaleway/configuration-loader

Weekly Downloads

2

Version

1.0.3

License

Apache-2.0

Unpacked Size

30.9 kB

Total Files

12

Last publish

Collaborators

  • codelax
  • quantumsheep
  • scaleway-bot
  • mprost
  • imanu
  • vincentaudebert
  • maliszewskid
  • phiphi