| 1 | # unicode-match-property-value-ecmascript [](https://travis-ci.org/mathiasbynens/unicode-match-property-value-ecmascript) [](https://www.npmjs.com/package/unicode-match-property-value-ecmascript)
|
|---|
| 2 |
|
|---|
| 3 | _unicode-match-property-value-ecmascript_ matches a given Unicode property value or [property value alias](https://github.com/mathiasbynens/unicode-property-value-aliases) to its canonical property value without applying [loose matching](https://github.com/mathiasbynens/unicode-loose-match), per the algorithm used for [RegExp Unicode property escapes in ECMAScript](https://github.com/tc39/proposal-regexp-unicode-property-escapes). Consider it a strict alternative to loose matching.
|
|---|
| 4 |
|
|---|
| 5 | ## Installation
|
|---|
| 6 |
|
|---|
| 7 | To use _unicode-match-property-value-ecmascript_ programmatically, install it as a dependency via [npm](https://www.npmjs.com/):
|
|---|
| 8 |
|
|---|
| 9 | ```bash
|
|---|
| 10 | $ npm install unicode-match-property-value-ecmascript
|
|---|
| 11 | ```
|
|---|
| 12 |
|
|---|
| 13 | Then, `require` it:
|
|---|
| 14 |
|
|---|
| 15 | ```js
|
|---|
| 16 | const matchPropertyValue = require('unicode-match-property-value-ecmascript');
|
|---|
| 17 | ```
|
|---|
| 18 |
|
|---|
| 19 | ## API
|
|---|
| 20 |
|
|---|
| 21 | This module exports a single function named `matchPropertyValue`.
|
|---|
| 22 |
|
|---|
| 23 | ### `matchPropertyValue(property, value)`
|
|---|
| 24 |
|
|---|
| 25 | 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.
|
|---|
| 26 |
|
|---|
| 27 | ```js
|
|---|
| 28 | // Find the canonical property value:
|
|---|
| 29 | matchPropertyValue('Script_Extensions', 'Aghb')
|
|---|
| 30 | // → 'Caucasian_Albanian'
|
|---|
| 31 |
|
|---|
| 32 | matchPropertyValue('Script_Extensions', 'Caucasian_Albanian')
|
|---|
| 33 | // → 'Caucasian_Albanian'
|
|---|
| 34 |
|
|---|
| 35 | matchPropertyValue('script_extensions', 'Caucasian_Albanian') // Note: incorrect casing.
|
|---|
| 36 | // → throws
|
|---|
| 37 |
|
|---|
| 38 | matchPropertyValue('Script_Extensions', 'caucasian_albanian') // Note: incorrect casing.
|
|---|
| 39 | // → throws
|
|---|
| 40 | ```
|
|---|
| 41 |
|
|---|
| 42 | ## For maintainers
|
|---|
| 43 |
|
|---|
| 44 | ### How to publish a new release
|
|---|
| 45 |
|
|---|
| 46 | 1. On the `main` branch, bump the version number in `package.json`:
|
|---|
| 47 |
|
|---|
| 48 | ```sh
|
|---|
| 49 | npm version patch -m 'Release v%s'
|
|---|
| 50 | ```
|
|---|
| 51 |
|
|---|
| 52 | Instead of `patch`, use `minor` or `major` [as needed](https://semver.org/).
|
|---|
| 53 |
|
|---|
| 54 | Note that this produces a Git commit + tag.
|
|---|
| 55 |
|
|---|
| 56 | 1. Push the release commit and tag:
|
|---|
| 57 |
|
|---|
| 58 | ```sh
|
|---|
| 59 | git push && git push --tags
|
|---|
| 60 | ```
|
|---|
| 61 |
|
|---|
| 62 | Our CI then automatically publishes the new release to npm.
|
|---|
| 63 |
|
|---|
| 64 | ## Author
|
|---|
| 65 |
|
|---|
| 66 | | [](https://twitter.com/mathias "Follow @mathias on Twitter") |
|
|---|
| 67 | |---|
|
|---|
| 68 | | [Mathias Bynens](https://mathiasbynens.be/) |
|
|---|
| 69 |
|
|---|
| 70 | ## License
|
|---|
| 71 |
|
|---|
| 72 | _unicode-match-property-value-ecmascript_ is available under the [MIT](https://mths.be/mit) license.
|
|---|
