# dotpath-compile

> Dot-path based JavaScript object template compiler.

Latest version **0.1.0** (published 2014-11-26) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install dotpath-compile
pnpm add dotpath-compile
yarn add dotpath-compile
bun add dotpath-compile
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2014-11-26 |
| First published | 2014-09-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Aleksandr Tsertkov |
| Maintainers | tsertkov |
| Keywords | dotpath, dot-path, compiler, compile, template, json |

## Links

- npm: https://www.npmjs.com/package/dotpath-compile
- Repository: git@github.com:tsertkov/dotpath-compile
- Homepage: https://github.com/tsertkov/dotpath-compile
- Issues: https://github.com/tsertkov/dotpath-compile/issues
- npm.io page: https://npm.io/package/dotpath-compile

## Dependencies (2)

- [lodash](https://npm.io/package/lodash.md) ^2.4.1
- [dotpath-resolve](https://npm.io/package/dotpath-resolve.md) ^0.1.3

## 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.0 (latest) — 2014-11-26
- 0.0.3 — 2014-09-23
- 0.0.2 — 2014-09-23

## README

# dotpath-compile

[![NPM](https://nodei.co/npm/dotpath-compile.png)](https://nodei.co/npm/dotpath-compile/)

[![Build Status](https://travis-ci.org/tsertkov/dotpath-compile.svg?branch=master)](https://travis-ci.org/tsertkov/dotpath-compile)
[![Coverage Status](https://img.shields.io/coveralls/tsertkov/dotpath-compile.svg)](https://coveralls.io/r/tsertkov/dotpath-compile?branch=master)
[![David Status](https://david-dm.org/tsertkov/dotpath-compile.png)](https://david-dm.org/tsertkov/dotpath-compile)

> Dot-path based JavaScript object template compiler.

## Features

- expand dot-path template variables
- flexible inheritance mechanism

## Usage

```javascript
var compile = require('dotpath-compile');
someobj = compile(someobj);
```

All use cases are described in [test code](https://github.com/tsertkov/dotpath-compile/blob/master/test/compile.js).


## Public API

### compile(obj)

Compile dotpath template variables in a given object.

**Parameters:**

- *obj* {Object | Array} - Object to be compiled

**Return Values:**

Returns compiled object.

## Private API

Complete API Documentation including private and public methods is generated from source code by JSDoc tool and is [available here](https://s3.eu-central-1.amazonaws.com/tsertkov-artifacts/dotpath-compile/master/jsdoc/index.html).

## Code coverage

Code coverage report for all files is [available here](https://s3.eu-central-1.amazonaws.com/tsertkov-artifacts/dotpath-compile/master/coverage/lcov-report/index.html).

## Scripts

- `npm test` - run tests
- `npm run jsdoc` - build jsdoc
- `npm run dev` - run tests continuously

## License

The MIT License (MIT)

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