# @ipmanlk/subasa-api

> Javascript API for Subasa Sinhala spell checker

Latest version **1.3.1** (published 2020-04-13) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @ipmanlk/subasa-api
pnpm add @ipmanlk/subasa-api
yarn add @ipmanlk/subasa-api
bun add @ipmanlk/subasa-api
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.3.1 |
| Published | 2020-04-13 |
| First published | 2020-02-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 6.1 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Navinda Dissanayake |
| Maintainers | ipmanlk |
| Keywords | subasa, sinhala, sri, lanka |

## Links

- npm: https://www.npmjs.com/package/@ipmanlk/subasa-api
- Repository: https://github.com/ipmanlk/subasa-api
- Homepage: https://github.com/ipmanlk/subasa-api#readme
- Issues: https://github.com/ipmanlk/subasa-api/issues
- npm.io page: https://npm.io/package/@ipmanlk/subasa-api

## Dependencies (1)

- [request](https://npm.io/package/request.md) ^2.88.0

## Recent versions

- 1.3.1 (latest) — 2020-04-13
- 1.3.0 — 2020-04-03
- 1.2.0 — 2020-02-08
- 1.0.0 — 2020-02-07

## README

<a href="http://speller.subasa.lk/">
    <img src="https://i.imgur.com/gBcNlON.png" alt="Subasa logo" title="Subasa" align="right" height="60" />
</a>

# Subasa API
_Javascript API for the Subasa Sinhala spell checker_

## Usage

Download node from nodejs.org and install it, if you haven't already.

Then install subasa-api using npm or yarn.

```javascript
npm install @ipmanlk/subasa-api --save
```

Example,

```javascript
const { correct } = require("@ipmanlk/subasa-api");

const text = "මථකය (ස්මෘතිය) යනු ජීවියෙකු තුළ තොරතුරු ගබඩා කිරීමට සහ ඉන්පසුව එම තොරතුරු ණැවත එලි දැක්වීමට ඇති හැකියාවයි.";

correct(text).then(data => {
    console.log("corrected text: ", data.text);
    console.log("corrections: ", data.corrections);
});
```

---
_Source: https://npm.io/package/@ipmanlk/subasa-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
