https://github.com/timthedev07/hash-speller

https://github.com/timthedev07/hash-speller

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/timthedev07/hash-speller
• Owner: timthedev07
• Created: 2021-04-11T11:22:27.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-08-20T21:35:29.000Z (over 3 years ago)
• Last Synced: 2024-12-10T10:30:10.580Z (27 days ago)
• Language: TypeScript
• Size: 2.74 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# hash-speller

This is a package that performs spell checking on a given chunk of text in the provided language.

## Why would I use this particular package?

Well, because it uses hash tables as its core data structure, which means once loading everything in, the speed of looking up any word would be nearly constant, `O(1)`.

## Installation

```bash

yarn add hash-speller

```

## Usage

```typescript

import { Checker } from "hash-speller";

const checker = new Checker("", "text you want to check");

const stats = checker.check(true /* if you want the stats to be printed out */);

```