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

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

unicode-match-property-value-ecmascript

unicode-match-property-value-ecmascript matches a given Unicode property value or property value alias to its canonical property value 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-value-ecmascript programmatically, install it as a dependency via npm:

$ npm install unicode-match-property-value-ecmascript

Then, require it:

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

API

This module exports a single function named matchPropertyValue.

matchPropertyValue(property, value)

This function takes a string property that is a canonical/unaliased Unicode property name, and a string value. It attemps to match value to a canonical Unicode property value for the given property. If there’s a match, it returns the canonical property value. Otherwise, it throws an exception.

// Find the canonical property value:
matchPropertyValue('Script_Extensions', 'Aghb')
// → 'Caucasian_Albanian'

matchPropertyValue('Script_Extensions', 'Caucasian_Albanian')
// → 'Caucasian_Albanian'

matchPropertyValue('script_extensions', 'Caucasian_Albanian') // Note: incorrect casing.
// → throws

matchPropertyValue('Script_Extensions', 'caucasian_albanian') // Note: incorrect casing.
// → throws

Author

| | |---| | Mathias Bynens |

License

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

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