# doxie-dummy

> A tiny utility for testing doxie plugins.

Latest version **0.2.0** (published 2015-06-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install doxie-dummy
pnpm add doxie-dummy
yarn add doxie-dummy
bun add doxie-dummy
```

## 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.2.0 |
| Published | 2015-06-22 |
| First published | 2015-06-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | © 2015 Studio B12 GmbH |
| Maintainers | tomekwi |

## Links

- npm: https://www.npmjs.com/package/doxie-dummy
- Repository: https://github.com/studio-b12/doxie-dummy
- Homepage: https://github.com/studio-b12/doxie-dummy#readme
- Issues: https://github.com/studio-b12/doxie-dummy/issues
- npm.io page: https://npm.io/package/doxie-dummy

## Recent versions

- 0.2.0 (latest) — 2015-06-22

## README

[![Coveralls – test coverage
](https://img.shields.io/coveralls/studio-b12/doxie-dummy.svg?style=flat-square)
](https://coveralls.io/r/studio-b12/doxie-dummy)
 [![Travis – build status
](https://img.shields.io/travis/studio-b12/doxie-dummy/master.svg?style=flat-square)
](https://travis-ci.org/studio-b12/doxie-dummy)
 [![David – status of dependencies
](https://img.shields.io/david/studio-b12/doxie-dummy.svg?style=flat-square)
](https://david-dm.org/studio-b12/doxie-dummy)
 [![Stability: unstable
](https://img.shields.io/badge/stability-unstable-yellowgreen.svg?style=flat-square)
](https://nodejs.org/api/documentation.html#documentation_stability_index)
 [![Code style: airbnb
](https://img.shields.io/badge/code%20style-airbnb-blue.svg?style=flat-square)
](https://github.com/airbnb/javascript)




doxie-dummy
===========

**A [tiny][] utility for testing *[doxie][]* plugins.**

[tiny]:   ./module/data.js
[doxie]:  http://npm.im/doxie




<p align="center"><a
  title="Graphic by the great Justin Mezzell"
  href="http://justinmezzell.tumblr.com/post/88665824413"
  >
  <br/>
  <br/>
  <img
    src="Readme/Matchbox.gif"
    width="400"
    height="300"
  />
  <br/>
  <br/>
</a></p>




Installation
------------

```sh
$ npm install doxie-dummy
```




Usage
-----

```js
const dummy = require('doxie-dummy');
const dummyData = require('doxie-dummy/data');
const dummyOutput = require('doxie-dummy/output');
```


&nbsp;


<h3><pre>
dummy(docs)
  → doxieData
</pre></h3>

**Parameters:**

* **`docs`**  
  <sup>type: Object[]</sup>  
  An array of docs. Each should match the signature `{[data], [output]}`.

**Return value:**  

* **`doxieData`**  
  <sup>type: Object</sup>  
  A doxie-compatible object. It can be piped into a plugin.


&nbsp;


<h3><pre>
dummyData(data)
  → doxieData
</pre></h3>

**Parameters:**

* **`data`**  
  <sup>type: *[]</sup>  
  An array of docs’ data – for example, coming from *dox*.

**Return value:**  

* **`doxieData`**  
  <sup>type: Object</sup>  
  A doxie-compatible object. It can be piped into a plugin.


&nbsp;


<h3><pre>
dummyOutput(outputs)
  → doxieData
</pre></h3>

**Parameters:**

* **`outputs`**  
  <sup>type: String[]</sup>  
  An array of docs’ output – for example, coming from [`doxie --render`](http://npm.im/doxie.render).

**Return value:**  

* **`doxieData`**  
  <sup>type: Object</sup>  
  A doxie-compatible object. It can be piped into a plugin.




License
-------

[MIT][] © [Studio B12 GmbH][]

[MIT]:              ./License.md
[Studio B12 GmbH]:  http://studio-b12.de

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