difficulty
Evaluating English word difficulty using word frequency data
Last updated a year ago by auphone .
ISC · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install difficulty 
SYNC missed versions from official npm registry.

Evaluating English word difficulty using word frequency data

Installation

cd ~/my-project/
npm install difficulty --save

Basic Usage

Async/Await

Welcome to ES7! ⎝( OωO)⎠

import { create } from 'difficulty';

(async () => {
  try {
    const difficulty = await create();
    const a = difficulty.getLevel('apple');
    const b = difficulty.getLevel('cappuccino');

    console.log(`apple is level ${a}, easy!`);
    console.log(`cappuccino is level ${b}, too hard!`);
  } catch(err) {
    console.error(err);
  }
})();

Output

apple is level 0, easy!
cappuccino is level 3, so hard!

Old schooler?

const Difficulty = require('difficulty');

// Using Promise
Difficulty.create().then((difficulty) => {
  ...
});

// Sync is available too!
const difficulty = Difficulty.createSync();

API

Difficulty.create(options)

filepath

Path to your csv file, in following format.

"Word","Freq_HAL"
"a","10610626"
...

Default: ./node_modules/difficulty/wordlist/wordlist.csv

levelsThreshold

Define your own levels with frequency threshold in descending order.

Default: [20000, 10000, 5000]

- Level 0: freq > 20000
- Level 1: 10001 to 20000
- Level 2: 5001 to 10000
- Level 3: < 5000 or **non exist words**

License

ISC

Important

The default word frequency data is generated from English Lexicon Project, which is for non-commercial research purposes only and may not be used in the development of speech technology. You should consider using your own wordlist for other purpose.

Author

github/auphone

Good luck! σ`∀´)σ

Current Tags

  • 1.2.0                                ...           latest (a year ago)

7 Versions

  • 1.2.0                                ...           a year ago
  • 1.1.4                                ...           a year ago
  • 1.1.3                                ...           a year ago
  • 1.1.2                                ...           a year ago
  • 1.1.1                                ...           a year ago
  • 1.1.0                                ...           a year ago
  • 1.0.0                                ...           a year ago
Maintainers (1)
Downloads
Today 0
This Week 1
This Month 1
Last Day 0
Last Week 0
Last Month 1
Dependencies (6)
Dev Dependencies (6)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |