doxie-dummy

A tiny utility for testing doxie plugins.

Usage no npm install needed!

<script type="module">
  import doxieDummy from 'https://cdn.skypack.dev/doxie-dummy';
</script>

README

Coveralls – test coverage Travis – build status David – status of dependencies Stability: unstable Code style: airbnb

doxie-dummy

A tiny utility for testing doxie plugins.





Installation

$ npm install doxie-dummy

Usage

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

 

dummy(docs)
→ doxieData

Parameters:

  • docs
    type: Object[]
    An array of docs. Each should match the signature {[data], [output]}.

Return value:

  • doxieData
    type: Object
    A doxie-compatible object. It can be piped into a plugin.

 

dummyData(data)
→ doxieData

Parameters:

  • data
    type: *[]
    An array of docs’ data – for example, coming from dox.

Return value:

  • doxieData
    type: Object
    A doxie-compatible object. It can be piped into a plugin.

 

dummyOutput(outputs)
→ doxieData

Parameters:

  • outputs
    type: String[]
    An array of docs’ output – for example, coming from doxie --render.

Return value:

  • doxieData
    type: Object
    A doxie-compatible object. It can be piped into a plugin.

License

MIT © Studio B12 GmbH