npm

Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript. Learn more »

talisman

0.21.0 • Public • Published

Build Status

Talisman

Full documentation

Talisman is a JavaScript library collecting series of algorithms related to the following domains:

Installation

You can install Talisman through npm:

npm install talisman

Documentation

The library's full documentation can be found here.

Goals

  • 📦 Modular: the library is completely modular. This means that if you only need to compute a levenshtein distance, you will only load the relevant code.
  • 💡 Straightfoward & simple: just want to compute a Jaccard index? No need to instantiate a class and use two methods to pass options and then finally succeed in getting the index. Just apply the jaccard function and get going.
  • 🍡 Consistent API: the library's API is fully consistent and one should not struggle to understand how to apply two different distance metrics.
  • 📯 Functional: except for cases where classes might be useful (classifiers notably), Talisman only uses functions, consumes raw data and order functions' arguments to make partial application & currying etc. as easy as possible.
  • ⚡️ Performant: the library should be as performant as possible for a high-level programming language library.
  • 🌐 Cross-platform: the library is cross-platform and can be used both with Node.js and in the browser.

Contribution

Contributions are of course welcome :)

Be sure to lint & pass the unit tests before submitting your pull request.

# Cloning the repo 
git clone git@github.com:Yomguithereal/talisman.git
cd talisman
 
# Installing the deps 
npm install
 
# Running the tests 
npm test
 
# Linting the code 
npm run lint

License

This project is available as open source under the terms of the MIT License.

install

npm i talisman

Downloadsweekly downloads

1,025

version

0.21.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability