# clue

> JSON based configuration loader and parser.

Latest version **0.1.2** (published 2015-04-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install clue
pnpm add clue
yarn add clue
bun add clue
```

## 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.1.2 |
| Published | 2015-04-21 |
| First published | 2015-04-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Hamza Waqas |
| Maintainers | arkeologen |
| Keywords | config, configuration, loader, parser, wrapper, config-loader, json |

## Links

- npm: https://www.npmjs.com/package/clue
- Repository: https://github.com/ArkeologeN/clue
- Issues: https://github.com/ArkeologeN/clue/issues
- npm.io page: https://npm.io/package/clue

## Dependencies (2)

- [chai](https://npm.io/package/chai.md) ^2.2.0
- [klass](https://npm.io/package/klass.md) ^1.4.0

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 0.1.2 (latest) — 2015-04-21
- 0.1.1 — 2015-04-03
- 0.1.0 — 2015-04-03

## README

# clue
JSON based configuration loader and parser.

# Install

To install, just run the following command:

```
$ npm install clue --save
```

It will be installed in your `node_modules/` directory and will added a dependency entry in `package.json`.

# Usage

The module would help to parse your custom JSON file and load the configuration successfully into the buffer. However, you could use alternative methods to get value by `dot notation` or it will return the default respectively.

```javascript

;(function() {
  var Clue = require('clue');

  var clue = new Clue('/path/to/json/file');
  var name = clue.get('name');  // Return `name` key from JSON file.
  var name = clue.get('name', 'ArkeologeN'); // If `name` key not found, it will return "ArkeologeN".
  var nested = clue.get('script.test'); // If will get the value of `test` key from the `script` object.
})();

```

# Author

Wrapper has been developed by [Hamza Waqas](http://twitter.com/HamzaWaqas)

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