README

:warning: DEPREACATED - please use wordnet-db :warning:

WNdb

A package to install WordNet database files for Node.js modules.

Used by wordpos project which is based on natural WordNet module.

Installation

npm install WNdb

or in your package.json dependencies:

  ...
  "dependencies": {
    "WNdb": "WNdb"
  },
  ...

Package is about 10 MB in size and uncompresses to about 34 MB. The DB file WNdb-3.1.tar.gz is unpacked at install time.

Description

This package contains the core DB files of WordNet 3.1 downloaded from WordNet files.

Other "standoff" files may be added in the future.

The purpose of this package is to allow a convenient way to download WordNet files off-line rather than on-demand for node modules that require it.

Usage

var WNdb = require('WNdb');
console.log(WNdb);
// output:
{ version: '3.1',
  path: 'c:\\wordpos\\node_modules\\WNdb\\dict',
  files:
   [ 'data.adj',
     'data.adv',
     'data.noun',
     'data.verb',
     'index.adj',
     'index.adv',
     'index.noun',
     'index.sense',
     'index.verb' ]
}

Properties

WNdb.path (string) -- the path to the installed WordNet DB files

WNdb.files (array) -- list of file names under the path

WNdb.version (string) -- version string of WordNet database file

Changes

v3.0.x are pegged to WordNet 3.0 DB.

v3.0.0 -- includes the uncompressed (text) dict files. On Windows systems, do a git config core.autocrlf false before cloning so that CRLF isn't applied to data files.

v3.0.1 -- this includes the actual WordNet tar file, which is unpacked at install time. There should be no CRLF issues. Uses build-in 'zlib' package, therefore requires node >= 0.6.

v3.1.0 -- updated to WordNet 3.1 DB.

v3.1.1 -- fixed WNdb tar folder structure.

License

See LICENSE file for complete Princeton University WordNet(r) License.

WNdbdeprecated

Usage no npm install needed!