https://github.com/rootslab/thrank
.
https://github.com/rootslab/thrank
Last synced: 8 months ago
JSON representation
.
- Host: GitHub
- URL: https://github.com/rootslab/thrank
- Owner: rootslab
- License: mit
- Created: 2018-02-16T21:36:24.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-02-16T21:42:46.000Z (over 8 years ago)
- Last Synced: 2025-09-11T13:51:51.083Z (9 months ago)
- Language: JavaScript
- Size: 35.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
### Thrank
[](https://www.npmjs.org/package/thrank)
[](https://www.codacy.com/public/44gatti/thrank)
[](https://codeclimate.com/github/rootslab/thrank)
[](https://github.com/rootslab/thrank#mit-license)
[](http://travis-ci.org/rootslab/thrank)
[](https://david-dm.org/rootslab/thrank)
[](https://david-dm.org/rootslab/thrank#info=devDependencies)
[](http://npm-stat.com/charts.html?package=thrank)
[](http://npm-stat.com/charts.html?package=thrank)
[](http://npm-stat.com/charts.html?package=thrank)
[](https://nodei.co/npm/thrank/)
> __Thrank__. Empty.
### Table of Contents
- __[Install](#install)__
- __[Run Tests](#run-tests)__
- __[Run Benchmarks](#run-benchmarks)__
- __[Constructor](#constructor)__
- __[Properties](#properties)__
- __[Methods](#methods)__
- __[do](#thrank.do)__
- __[Events](#events)__
- __[Examples](#examples)__
- __[MIT License](#mit-license)__
------------------------------------------------------------------------------
### Install
```bash
$ npm install thrank [-g]
```
> __require__:
```javascript
const Thrank = require( 'thrank' );
```
### Run Tests
> __to run all test files, install devDependencies:__
```bash
$ cd thrank/
# install or update devDependencies
$ npm install
# run tests
$ npm test
```
> __to execute a single test file simply do__:
```bash
$ node test/file-name.js
```
### Run Benchmarks
```bash
$ cd thrank/
$ npm run bench
```
> __to execute a single bench file, simply do__:
```bash
$ node bench/file-name.js
```
### Constructor
> Arguments between [ ] are optional.
```javascript
Thrank( [ Buffer sequence | String sequence | Number sequence ] )
```
> or
```javascript
new Thrank( [ Buffer sequence | String sequence | Number sequence ] )
```
> __NOTE__: default is.
### Properties
> __NOTE__: do not mess up with these properties.
##### Thrank.
```javascript
//
```
##### Thrank.
```javascript
//
```
### Methods
> Arguments between [ ] are optional.
| name | description |
|:------------------------|:-----------------------------------------------------------------|
| __[do](#skeldo)__ | `...` |
#### Thrank.do
> ##### .
```javascript
```
### Events
```javascript
/*
*
*/
```
### Examples
#### ..:
> - __[](example/thrank-example.js)__
> - ...
> See __[examples](example/)__.
### MIT License
> Copyright (c) 2018-present < Guglielmo Ferri : 44gatti@gmail.com >
> 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.