# engine-paths

> Keeping the Engine paths in one place.

Latest version **1.0.1** (published 2015-12-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install engine-paths
pnpm add engine-paths
yarn add engine-paths
bun add engine-paths
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2015-12-04 |
| First published | 2015-12-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | jillix |
| Maintainers | ionicabizau |
| Keywords | engine, jillix, paths |

## Links

- npm: https://www.npmjs.com/package/engine-paths
- Repository: https://github.com/jillix/engine-paths
- Homepage: https://github.com/jillix/engine-paths#readme
- Issues: https://github.com/jillix/engine-paths/issues
- npm.io page: https://npm.io/package/engine-paths

## Dependencies (1)

- [abs](https://npm.io/package/abs.md) ^1.2.0

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2015-12-04
- 1.0.0 — 2015-12-01

## README

# engine-paths

Keeping the Engine paths in one place.

## Installation

```sh
$ npm i --save engine-paths
```

## Example

```js
const EnginePaths = require("engine-paths");

var paths = new EnginePaths("path/to/your/app");

console.log(paths.root);
// => /home/.../path/to/your/app

console.log(paths.composition);
// => /home/.../path/to/your/app/composition

console.log(paths.package);
// => /home/.../path/to/your/app/package.json

console.log(paths.service);
// => /home/.../path/to/your/app/.service.json

console.log(paths.instance("some-instance"));
// => /home/.../path/to/your/app/composition/some-instance.json
```

## Documentation

### `EnginePaths(appPath)`
Creates a new instance of `EnginePaths`.

#### Params
- **String** `appPath`: The path to the Engine app.

### `instance(name)`
Gets the absolute path to the JSON file.

#### Params
- **String** `name`: The instance name (without the `.json` suffix).

#### Return
- **String** The absolute path to the instance file.

## How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].

## Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:

## License

[MIT][license] © [jillix][website]

[license]: http://showalicense.com/?fullname=jillix%20%3Ccontact%40jillix.com%3E%20(http%3A%2F%2Fjillix.com)&year=2015#license-mit
[website]: http://jillix.com
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md

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