node_modules/unicode-match-property-ecmascript/README.md

In thisisnic/starrating: What the Package Does (One Line, Title Case)

unicode-match-property-ecmascript

unicode-match-property-ecmascript matches a given Unicode property or property alias to its canonical property name without applying loose matching per the algorithm used for RegExp Unicode property escapes in ECMAScript. Consider it a strict alternative to loose matching.

Installation

To use unicode-match-property-ecmascript programmatically, install it as a dependency via npm:

$ npm install unicode-match-property-ecmascript

Then, require it:

const matchProperty = require('unicode-match-property-ecmascript');

API

This module exports a single function named matchProperty.

matchProperty(value)

This function takes a string value and attempts to match it to a canonical Unicode property name. If there’s a match, it returns the canonical property name. Otherwise, it throws an exception.

// Find the canonical property name:
matchProperty('sc')
// → 'Script'

matchProperty('Script')
// → 'Script'

matchProperty('script') // Note: incorrect casing.
// → throws

Author

| | |---| | Mathias Bynens |

License

unicode-match-property-ecmascript is available under the MIT license.

thisisnic/starrating documentation built on May 18, 2019, 1:32 p.m.