# raml-object-to-raml

> Takes a RAML object in JavaScript and emits properly-formatted RAML (text).

Latest version **0.0.7** (published 2016-03-25) · Apache 2.0 license · 0 weekly downloads

## Install

```sh
npm install raml-object-to-raml
pnpm add raml-object-to-raml
yarn add raml-object-to-raml
bun add raml-object-to-raml
```

Provides the command `raml-object-to-raml`.

## 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.7 |
| Published | 2016-03-25 |
| First published | 2014-11-18 |
| Weekly downloads | 0 |
| License | Apache 2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | MuleSoft, Inc. |
| Maintainers | blakeembrey |
| Keywords | raml, object, file, text |

## Links

- npm: https://www.npmjs.com/package/raml-object-to-raml
- Repository: https://github.com/mulesoft/raml-object-to-raml
- Issues: https://github.com/mulesoft/raml-object-to-raml/issues
- npm.io page: https://npm.io/package/raml-object-to-raml

## Dependencies (5)

- [xtend](https://npm.io/package/xtend.md) ^4.0.0
- [concat-stream](https://npm.io/package/concat-stream.md) ^1.4.6
- [indent-string](https://npm.io/package/indent-string.md) ^2.1.0
- [repeat-string](https://npm.io/package/repeat-string.md) ^1.5.2
- [string-length](https://npm.io/package/string-length.md) ^1.0.0

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 0.0.7 (latest) — 2016-03-25
- 0.0.6 — 2016-03-02
- 0.0.5 — 2015-09-04
- 0.0.4 — 2015-01-07
- 0.0.3 — 2014-11-19
- 0.0.2 — 2014-11-19
- 0.0.1 — 2014-11-18

## README

# RAML Object To RAML

[![NPM version][npm-image]][npm-url]
[![Build status][travis-image]][travis-url]
[![Test coverage][coveralls-image]][coveralls-url]

Takes a RAML object in JavaScript and emits properly-formatted RAML (text).

## Installation

```
npm install raml-object-to-raml --save
```

## Usage

### CLI

Supports piping in JSON and printing the resulting RAML to stdout.

```
cat api.json | raml-object-to-raml > api.raml
```

### JavaScript

The module can be required inside other projects for generating the RAML file directly from JavaScript objects.

```javascript
var toRAML = require('raml-object-to-raml');

console.log(toRAML({ ... }));
// #%RAML 0.8
// title: Example API
// ...
```

## License

Apache 2.0

[npm-image]: https://img.shields.io/npm/v/raml-object-to-raml.svg?style=flat
[npm-url]: https://npmjs.org/package/raml-object-to-raml
[travis-image]: https://img.shields.io/travis/mulesoft/raml-object-to-raml.svg?style=flat
[travis-url]: https://travis-ci.org/mulesoft/raml-object-to-raml
[coveralls-image]: https://img.shields.io/coveralls/mulesoft/raml-object-to-raml.svg?style=flat
[coveralls-url]: https://coveralls.io/r/mulesoft/raml-object-to-raml?branch=master

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