Thrank

Skel.

Table of Contents

• Install
• Run Tests
• Run Benchmarks
• Constructor
• Properties
• Methods
  • do
• Events
• Examples
• MIT License

Install

$ npm install thrank [-g]

require:

const Thrank  = require( 'thrank' );

Run Tests

to run all test files, install devDependencies:

 $ cd thrank/
 # install or update devDependencies
 $ npm install 
 # run tests
 $ npm test

to execute a single test file simply do:

 $ node test/file-name.js

Run Benchmarks

$ cd thrank/
$ npm run bench

to execute a single bench file, simply do:

 $ node bench/file-name.js

Constructor

Arguments between [ ] are optional.

Thrank( [ Buffer sequence | String sequence | Number sequence ] )

or

new Thrank( [ Buffer sequence | String sequence | Number sequence ] )

NOTE: default is.

Properties

NOTE: do not mess up with these properties.

Thrank.

//

Thrank.

//

Methods

Arguments between [ ] are optional.

| name | description | |:------------------------|:-----------------------------------------------------------------| | do | ... |

Thrank.do

.

Events

/*
 *
 */

Examples

..:

• ...

See examples.

MIT License

Copyright (c) 2018-present < Guglielmo Ferri : [email protected] >

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.