fileable-iterator
v0.0.3
Published
![fileable logo](./static/docs/logo.png)
Downloads
6
Readme
Fileable Iterator
For use internally with fileable and components.
Installation
npm install fileable-iterator
API
Table of contents
function iterator
Iterator
| Parameter | Type | Description |
| :------------------------- | :----- | :------------------------------------------------------------------------------------- |
| options
| object | |
| options.folder_context
| string | Folder into which files should be rendered. |
| options.template_context
| string | Location of template. Used to determine relative relative paths of certain attributes. |
Examples
import {iterator} from 'fileable'; const main = async ()=>{ for await(const output of iterator(template, {})){ console.log(output); } }
Todo
- remove unnecessary dependencies
- add proper typescript typeings
- Update console renderer: https://en.wikipedia.org/wiki/Box-drawing_character