general-category

Look up General_Category of Unicode character with JavaScript.

News: The package was considerably slimed down :arrow_down: as of version 1.4.0 :raised_hands:

$ du -h `npm pack [email protected]`
184K    general-category-1.3.0.tgz
$ du -h `npm pack [email protected]`
24K     general-category-1.4.0.tgz
$ du -h `npm pack [email protected]`
17K     general-category-1.5.0.tgz

Usage

const category = require('general-category');

// Just gimme character and you'll get category.
category('Å'); //=> 'Lu'

// This module is aware of surrogate pairs.
category('\u{1F600}'); //=> 'So'

// Providing code point also works.
category(0x0020); //=> 'Zs'

// You'll get category data with latest version of Unicode by default.
// You can switch it by `version` option
category('\u{1F600}', {version: '6.0.0'}); //=> 'Cn'

// If you are only interested in the specific version of Unicode,
// you can require the module with limited data loaded.
const category3_2_0 = require('general-category/3.2.0');
category3_2_0('\u{1F600}'); //=> 'Cn'

// 'latest' version also works.
const categoryLatest = require('general-category/latest');
categoryLatest('\u{1F600}'); //=> 'So'

// You can get long_name instead of an abbreviated one.
category('Ä', {long: true}); //=> 'Uppercase_Letter'

// You can also get detaild information of category.
category('Ä', {detailed: true}); //=> { large: 'L', small: 'Lu' }

API

This module exposes single function category(character[, options]).

• character [String | Number]: Character or code point to look up for General_Category
• options [Object]:
  • long [Boolean]: Returns long_name instead of abbreviated form. Default is false.
  • detailed [Boolean]: Returns detailed category information instead of plain string. Default is false.
  • version [String | Null]: Version number to use as unicode data source. You can set null to use latest version included. These versions are derived from node-unicode-data and currently all available versions are:
    • 1.1.5
    • 2.0.14
    • 2.1.2
    • 2.1.5
    • 2.1.8
    • 2.1.9
    • 3.0.0
    • 3.0.1
    • 3.1.0
    • 3.2.0
    • 4.0.0
    • 4.0.1
    • 4.1.0
    • 5.0.0
    • 5.1.0
    • 5.2.0
    • 6.0.0
    • 6.1.0
    • 6.2.0
    • 6.3.0
    • 7.0.0
    • 8.0.0
    • 9.0.0
• return [String | Object]: General_Category of the given character. If options.detailed is set true, returns object with detailed category information.