@scaleway/configuration-loader 0.1.0-alpha.2 → 0.1.0-alpha.5

package/README.md

@@ -0,0 +1,57 @@
+# Configuration Loader
+
+Scaleway is a single way to create, deploy and scale your infrastructure in the cloud.
+
+This package enables you to load a profile from a configuration file or environment variables.
+
+**🔗  Important links:**
+* [Scaleway SDK](./sdk)
+* [Developers website](https://developers.scaleway.com) (API documentation)
+
+## Getting Started
+
+You could hardcode a profile directly within your code:
+
+```ts
+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 instanciate the [SDK](./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**:
+
+```ts
+import { 
+  loadProfileFromConfigurationFile, 
+} from '@scaleway/configuration-loader'
+
+const profile = loadProfileFromConfigurationFile()
+```
+
+For a specific profile:
+
+```ts
+const profile = loadProfileFromEnvironmentValues({ profileName: 'debug' })
+```
+
+**In case of environment variables**:
+
+```ts
+import { 
+  loadProfileFromEnvironmentValues,
+} from '@scaleway/configuration-loader'
+
+const profile = loadProfileFromEnvironmentValues()
+```
+
+## Reach us
+
+We love feedback. Feel free to reach us on [Scaleway Slack community](https://slack.scaleway.com/), we are waiting for you on [#opensource](https://scaleway-community.slack.com/app_redirect?channel=opensource).

package/dist/index.d.ts

@@ -81,6 +81,6 @@ declare const loadProfileFromEnvironmentValues: () => Profile;
  *
  * @public
  */
-declare const loadProfileFromConfigurationFile: (params?: Readonly<ProfileFromFileParams> | undefined) => Profile;
+declare const loadProfileFromConfigurationFile: (params?: Readonly<ProfileFromFileParams>) => Profile;
 
 export { Profile, ProfileFromFileParams, loadProfileFromConfigurationFile, loadProfileFromEnvironmentValues };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/configuration-loader",
-  "version": "0.1.0-alpha.2",
+  "version": "0.1.0-alpha.5",
   "license": "Apache-2.0",
   "description": "Load configuration via file or environment for NodeJS.",
   "main": "dist/index.cjs",
@@ -18,7 +18,7 @@
   },
   "type": "module",
   "devDependencies": {
-    "@types/node": "^17.0.31"
+    "@types/node": "^17.0.36"
   },
-  "gitHead": "5a056e1fdbf30b3300fbdf861b22f0b6bb25af60"
+  "gitHead": "b0867328654a44d7eb69e41e7f0330c4249f6762"
 }