# file-keyword-density

> Keyword density analyzer for contents in a text or html file

Latest version **0.0.1** (published 2018-06-01) · ISC license · 0 weekly downloads

## Install

```sh
npm install file-keyword-density
pnpm add file-keyword-density
yarn add file-keyword-density
bun add file-keyword-density
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2018-06-01 |
| First published | 2018-06-01 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 43.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Tim Hysniu |
| Maintainers | timhysniu |
| Keywords | keyword, density, analyzer, file, text, html |

## Links

- npm: https://www.npmjs.com/package/file-keyword-density
- Repository: https://github.com/timhysniu/file-keyword-density
- Homepage: https://github.com/timhysniu/file-keyword-density#readme
- Issues: https://github.com/timhysniu/file-keyword-density/issues
- npm.io page: https://npm.io/package/file-keyword-density

## Dependencies (1)

- [striptags](https://npm.io/package/striptags.md) ^3.1.1

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 0.0.1 (latest) — 2018-06-01

## README

# file-keyword-density

Analyze keyword density of an entire text/html file

## Tests

```
npm test
```

## Usage

```
const TEXT_FILE_PATH = '...';      // html or text file with your keywords
const STOP_WORD_FILE_PATH = '...'; // set if you don't want to use default one
const bulkdensity = require('./density');
const bk = new bulkdensity(TEXT_FILE_PATH, {minKeywordLength: 3, stopWordFile: STOP_WORD_FILE_PATH});

bk.getDensity()
    .then((keywords) => {
        console.log(JSON.stringify(keywords));
    })
    .catch((err) => {
        console.error(err);
    });
```

---
_Source: https://npm.io/package/file-keyword-density · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._