0.1.1 • Published 5 years ago

@mikazuki/lookenv v0.1.1

Weekly downloads
15
License
MIT
Repository
github
Last release
5 years ago

LookEnv

GitHub npm (scoped)

Lookup values from environment variables and cloud secure variables

Install

yarn add @mikazuki/lookenv

How to use

Environment Variable

import LookEnv from "@mikazuki/lookenv";

const env = new LookEnv();

await env.has("NODE_ENV"); // => true
await env.get("NODE_ENV"); // => development

You can use type-definitions for parameters, please see below example.

import LookEnv from "@mikazuki/lookenv";

type EnvValues = "NODE_ENV";

const env = new LookEnv<EnvValues>();

await env.has("NODE_ENV");         // => compile ok
await env.has("NODE_ENVIRONMENT"); // => compile failure

Azure Key Vault

LookEnv supports Azure Key Vault as Key Store.
You have to install additional dependencies.

# install additional dependencies
> yarn add @azure/identity @azure/keyvault-secrets
import { EnvironmentCredential } from "@azure/identity";
import LookEnv, { AzureIdentity } from "@mikazuki/lookenv";

const azure = new AzureIdentity("<MY KEY VAULT HERE>", new EnvironmentCredential());
const env = new LookEnv(azure);

await env.has("AZURE_KEY_VAULT_SECRET"); // => try to get secret `AzureKeyVaultSecret` from Azure

If you want to see real-world example?
Please check-out Knockru/Crouton repository!