https://github.com/talyssonoc/jst9

A text-prediction JavaScript tool
https://github.com/talyssonoc/jst9

Last synced: 12 days ago
JSON representation

A text-prediction JavaScript tool

• Host: GitHub
• URL: https://github.com/talyssonoc/jst9
• Owner: talyssonoc
• License: mit
• Created: 2013-09-04T23:27:06.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2015-04-29T23:22:05.000Z (over 9 years ago)
• Last Synced: 2024-10-04T11:56:16.685Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 340 KB
• Stars: 64
• Watchers: 5
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# jsT9

[![Build Status](https://travis-ci.org/talyssonoc/jsT9.svg?branch=master)](https://travis-ci.org/talyssonoc/jsT9) [![Code Climate](https://codeclimate.com/github/talyssonoc/jsT9/badges/gpa.svg)](https://codeclimate.com/github/talyssonoc/jsT9)

## Installation

With npm

```

  $ npm install jst9 --save

```

With Bower

```

  $ bower install jst9 --save

```

Or copy some of the files inside `dist` folder.

On browsers, it exports the `jsT9` global.

## Usage

To create a new jsT9 instance, you show use the constructor like this:

```

  var tree = new jsT9(words[, settings]);

```

Where:

- `words` can be:

  - An array of words, or

  - A string with the path of a JSON file with a field called 'words' containing the array of words (see the words.json example file). See `ready` method on the API below.

- `settings` (optional)

  - `sort`: A `sort(A, B)` (__Default__: Alphabetical order) function that returns:  

    - -1 if `A < B`

    - 1 if `A > B`

    - 0 if `A == B`

  - `maxAmount`: Default max amount of predictions to be returned (__Default__: `Infinity`).

  - `slackSearch`: Search words using [slack search](#how-slack-search-works) (__Default__: `true`).

## API

- `predict(word)`: Return the predictions to the given word.

- `addWord(word)`: Add an new word to the tree.

- `ready(callback)`: Runs the callback when the tree is ready, useful when you're loading the words with JSON.

## How slack search works

If no complete word in the tree matches the searched word, the slack search will remove the last character of the word, one by one, until it finds a match.

Example:

Given this word list:

  - List

  - Look

  - Loop

If you try predict `Loo`, you'll get `["Look", "Loop"]`.

But if you try predict `Lx`, the algorithm won't find a match, so it will remove the "x" and try to predict `L`, then you'll get `["List", "Look", "Loop"]`.