https://github.com/bifravst/from-env

Helper function which ensures that required environment variables are set.
https://github.com/bifravst/from-env

iot nrf-asset-tracker

Last synced: about 1 month ago
JSON representation

Helper function which ensures that required environment variables are set.

• Host: GitHub
• URL: https://github.com/bifravst/from-env
• Owner: bifravst
• License: bsd-3-clause
• Created: 2022-01-27T12:30:46.000Z (almost 3 years ago)
• Default Branch: saga
• Last Pushed: 2024-07-12T11:55:47.000Z (5 months ago)
• Last Synced: 2024-07-12T13:21:58.803Z (5 months ago)
• Topics: iot, nrf-asset-tracker
• Language: TypeScript
• Homepage: https://github.com/NordicSemiconductor/from-env-js#readme
• Size: 2.11 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# fromEnv [![npm version](https://img.shields.io/npm/v/@bifravst/from-env.svg)](https://www.npmjs.com/package/@bifravst/from-env)

[![GitHub Actions](https://github.com/bifravst/from-env/workflows/Test%20and%20Release/badge.svg)](https://github.com/bifravst/from-env/actions)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com)

[![@commitlint/config-conventional](https://img.shields.io/badge/%40commitlint-config--conventional-brightgreen)](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier/)

[![ESLint: TypeScript](https://img.shields.io/badge/ESLint-TypeScript-blue.svg)](https://github.com/typescript-eslint/typescript-eslint)

Helper function which ensures that required environment variables are set.

## Example

```typescript

import { fromEnv } from "@bifravst/from-env";

const { env } = fromEnv({

  env: "MY_ENV",

})(process.env);

```

This will throw an exception if `MY_ENV` is not set on `process.env`. Otherwise,

`env` will not contain the value of `process.env.MY_ENV`.

## Installation

    npm i --save-dev --save-exact @bifravst/from-env

## Usage

See [`fromEnv.spec.ts`](./src/fromEnv.spec.ts).