Skip to content

Files

This branch is 26542 commits behind ethereum/aleth:master.

natspecjs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Mar 9, 2015
Mar 9, 2015
Mar 9, 2015
Mar 9, 2015
Mar 9, 2015
Mar 9, 2015
Mar 9, 2015
Mar 9, 2015

natspec.js

Javascript Library used to evaluate natspec expressions

Build Status Coverage Status

Usage

It exposes global object natspec with method evaluateExpression.

var natspec = require('natspec');

var natspecExpression = "Will multiply `a` by 7 and return `a * 7`.";
var call = {
    method: 'multiply',
    abi: abi,
    transaction: transaction
};

var evaluatedExpression = natspec.evaluateExpression(natspecExpression, call);
console.log(evaluatedExpression); // "Will multiply 4 by 7 and return 28."

More examples are available here.

Building

npm run-script build

Testing (mocha)

npm test

Wiki