
Security News
ECMAScript 2025 Finalized with Iterator Helpers, Set Methods, RegExp.escape, and More
ECMAScript 2025 introduces Iterator Helpers, Set methods, JSON modules, and more in its latest spec update approved by Ecma in June 2025.
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
function add(a, b) {
return a + b;
}
// type checkers from annois (https://npmjs.org/package/annois)
var addNumbers = annotate('addNumbers', 'Adds numbers').
on(is.number, is.number, add);
var addStrings = annotate('addStrings', 'Adds strings').
on(is.string, is.string, add);
// you can assert invariants too
var addPositive = annotate('addPositive', 'Adds positive').
on(isPositive, isPositive, add).
satisfies(isPositive); // postcondition
// it is possible to chain guards
var fib = annotate('fib', 'Calculates Fibonacci numbers').
on(0, 0).on(1, 1).
on(is.number, function(n) {
return fib(n - 1) + fib(n - 2);
});
// invariants may depend on each other
var clamp = annotate('clamp', 'Clamps given number between given bounds').
on(is.number, is.number, function(a, args) {
return is.number(a) && args[1] <= a;
}, function(a, min, max) {
return Math.max(Math.min(a, max), min);
});
// furthermore it is possible to pass a variable amount of args
var min = annotate('min', 'Returns minimum of the given numbers').
on([is.number], Math.min);
function isPositive(a) {
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.
annotate.js
and suite.js
annotate
is available under MIT. See LICENSE for more details.
FAQs
Asserts your function invariants
The npm package annotate receives a total of 2,396 weekly downloads. As such, annotate popularity was classified as popular.
We found that annotate demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ECMAScript 2025 introduces Iterator Helpers, Set methods, JSON modules, and more in its latest spec update approved by Ecma in June 2025.
Security News
A new Node.js homepage button linking to paid support for EOL versions has sparked a heated discussion among contributors and the wider community.
Research
North Korean threat actors linked to the Contagious Interview campaign return with 35 new malicious npm packages using a stealthy multi-stage malware loader.