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