# cdk8s-config

> Add configuration features using environment variables.

Latest version **0.0.9** (published 2020-06-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install cdk8s-config
pnpm add cdk8s-config
yarn add cdk8s-config
bun add cdk8s-config
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.9 |
| Published | 2020-06-08 |
| First published | 2020-05-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 13.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Jonas Schmitt |
| Maintainers | kumboleijo |
| Keywords | cdk8s, config |

## Links

- npm: https://www.npmjs.com/package/cdk8s-config
- Repository: https://github.com/kumboleijo/cdk8s-config
- Issues: https://github.com/kumboleijo/cdk8s-config/issues
- npm.io page: https://npm.io/package/cdk8s-config

## Dependencies (4)

- [dotenv](https://npm.io/package/dotenv.md) ^8.2.0
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.13.1
- [brototype](https://npm.io/package/brototype.md) ^0.0.6
- [deepmerge](https://npm.io/package/deepmerge.md) ^4.2.2

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 0.0.9 (latest) — 2020-06-08
- 0.0.8 — 2020-06-04
- 0.0.7 — 2020-06-04
- 0.0.6 — 2020-05-28
- 0.0.4 — 2020-05-28
- 0.0.3 — 2020-05-27

## README

# cdk8s-config

Add configuration 🛠 features to your cdk8s project.

[![GitHub version](https://badge.fury.io/gh/kumboleijo%2Fcdk8s-config.svg)](https://badge.fury.io/gh/kumboleijo%2Fcdk8s-config)
[![npm version](https://badge.fury.io/js/cdk8s-config.svg)](https://badge.fury.io/js/cdk8s-config)

## Overview 👀

```yaml
# my-config.yaml
# --------------

my-key:
  key1: value1
```

```ts
// index.ts
// --------

import Config from 'cdk8s-config';

const CONFIG = await Config.fromFile('<path to your config yaml>');
const data = CONFIG.get();

// data = { 'my-key': { 'key1': 'value1' } }
```

## Installation 💻

```sh
$ npm i cdk8s-config
```

or

```sh
$ yarn add cdk8s-config
```

## Documentation 📖
 
Check out the full documentation here: https://kumboleijo.github.io/cdk8s-config/

## Run the Examples 🏃🏽‍♀️

```sh
$ npx ts-node ./examples/1-basic/
```

---
_Source: https://npm.io/package/cdk8s-config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._