validate-noddity-post
v3.0.1
Published
Assert that a Noddity post file can be parsed by the butler, and rendered by Ractive.
Downloads
40
Readme
Validate noddity posts so that you can be guaranteed that their metadata is valid/parseable, and the contents can be rendered by the templating engine.
API
const Validator = require('validate-noddity-post')
const validate = Validator({
butler,
linkifier,
data
})
require
returns a constructor function:
constructor({ butler, linkifier, data, [template] })
- butler: a noddity-butler
- linkifier: noddity-linkifier
- data: passed to noddity-render-static
- template: an optional post template
The constructor function returns a validator function:
validator function(post)
Returns a promise that resolves with an object. If there is anything wrong with the post it will have an error
property.
If the promise is rejected, then something is wrong with the universe, which is a distinct possibility when you're interacting with physical disks and internets and whatnot.
Example
validate('my-newest-post.md').then(({ error }) => {
if (error) {
console.log('your post sucks!', error)
}
})