Bakhtina Sofya b84cb877be 1st comm 1 month ago
..
LICENSE-MIT.txt b84cb877be 1st comm 1 month ago
README.md b84cb877be 1st comm 1 month ago
index.js b84cb877be 1st comm 1 month ago
package.json b84cb877be 1st comm 1 month ago

README.md

unicode-match-property-ecmascript Build status unicode-match-property-ecmascript on npm

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

For maintainers

How to publish a new release

  1. On the main branch, bump the version number in package.json:

    npm version patch -m 'Release v%s'
    

    Instead of patch, use minor or major as needed.

    Note that this produces a Git commit + tag.

  2. Push the release commit and tag:

    git push && git push --tags
    

    Our CI then automatically publishes the new release to npm.

Author

twitter/mathias
Mathias Bynens

License

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