source: trip-planner-front/node_modules/unicode-match-property-value-ecmascript/README.md@ 8d391a1

Last change on this file since 8d391a1 was 6a3a178, checked in by Ema <ema_spirova@…>, 3 years ago

initial commit

  • Property mode set to 100644
File size: 2.8 KB
Line 
1# unicode-match-property-value-ecmascript [![Build status](https://travis-ci.org/mathiasbynens/unicode-match-property-value-ecmascript.svg?branch=main)](https://travis-ci.org/mathiasbynens/unicode-match-property-value-ecmascript) [![unicode-match-property-value-ecmascript on npm](https://img.shields.io/npm/v/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
7To 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
13Then, `require` it:
14
15```js
16const matchPropertyValue = require('unicode-match-property-value-ecmascript');
17```
18
19## API
20
21This module exports a single function named `matchPropertyValue`.
22
23### `matchPropertyValue(property, value)`
24
25This 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:
29matchPropertyValue('Script_Extensions', 'Aghb')
30// → 'Caucasian_Albanian'
31
32matchPropertyValue('Script_Extensions', 'Caucasian_Albanian')
33// → 'Caucasian_Albanian'
34
35matchPropertyValue('script_extensions', 'Caucasian_Albanian') // Note: incorrect casing.
36// → throws
37
38matchPropertyValue('Script_Extensions', 'caucasian_albanian') // Note: incorrect casing.
39// → throws
40```
41
42## For maintainers
43
44### How to publish a new release
45
461. 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
561. 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| [![twitter/mathias](https://gravatar.com/avatar/24e08a9ea84deb17ae121074d0f17125?s=70)](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.
Note: See TracBrowser for help on using the repository browser.