You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

43 lines
1.4 KiB

4 years ago
  1. # regenerate-unicode-properties [![Build status](https://travis-ci.org/mathiasbynens/regenerate-unicode-properties.svg?branch=master)](https://travis-ci.org/mathiasbynens/regenerate-unicode-properties)
  2. _regenerate-unicode-properties_ is a collection of [Regenerate](https://github.com/mathiasbynens/regenerate) sets for [various Unicode properties](https://github.com/tc39/proposal-regexp-unicode-property-escapes).
  3. ## Installation
  4. To use _regenerate-unicode-properties_ programmatically, install it as a dependency via [npm](https://www.npmjs.com/):
  5. ```bash
  6. $ npm install regenerate-unicode-properties
  7. ```
  8. ## Usage
  9. To get a map of supported properties and their values:
  10. ```js
  11. const properties = require('regenerate-unicode-properties');
  12. ```
  13. To get a specific Regenerate set:
  14. ```js
  15. // Examples:
  16. const Lu = require('regenerate-unicode-properties/General_Category/Uppercase_Letter.js');
  17. const Greek = require('regenerate-unicode-properties/Script_Extensions/Greek.js');
  18. ```
  19. To get the Unicode version the data was based on:
  20. ```js
  21. const unicodeVersion = require('regenerate-unicode-properties/unicode-version.js');
  22. ```
  23. ## Author
  24. | [![twitter/mathias](https://gravatar.com/avatar/24e08a9ea84deb17ae121074d0f17125?s=70)](https://twitter.com/mathias "Follow @mathias on Twitter") |
  25. |---|
  26. | [Mathias Bynens](https://mathiasbynens.be/) |
  27. ## License
  28. _regenerate-unicode-properties_ is available under the [MIT](https://mths.be/mit) license.