annotate - Annotate your JavaScript function definitions
annotate
allows you to ... guess what ... annotate your functions. For
instance you could document invariants of your function. Or attach a
description to it. It is possible to access this data later on.
This metadata can be used by tools such as annofuzz in order to generate tests. In addition you can access the metadata via REPL.
The usage is quite simple as the following example illustrates:
// let's define some function to annotate { return a + b;} // type checkers from annois (https://npmjs.org/package/annois)var addNumbers = ;var addStrings = ; // you can assert invariants toovar addPositive = ; // postcondition // it is possible to chain guardsvar fib = ; // invariants may depend on each othervar clamp = ; // furthermore it is possible to pass a variable amount of argsvar min = ; { return a >= 0;}
The annotate
function will create a new function that contains the metadata as
properties _name
, _doc
, _preconditions
and _postconditions
. In case
some pre- or postcondition doesn't pass it won't return and gives a warning
instead.
Related Projects
- suite.js - Constructs tests based on invariant data (fuzzing)
- funkit - Collection of utilities tested using
annotate.js
andsuite.js
Acknowledgements
- Kris Jordan's multimethod.js - Provided inspiration for the API
License
annotate
is available under MIT. See LICENSE for more details.