Skip to content

Commit

Permalink
docs(readme): update usage
Browse files Browse the repository at this point in the history
  • Loading branch information
ikatyang committed Mar 21, 2018
1 parent ae5851a commit d87ae92
Showing 1 changed file with 18 additions and 13 deletions.
31 changes: 18 additions & 13 deletions README.md
Expand Up @@ -21,21 +21,26 @@ yarn add cjk-regex
## Usage

```js
const get_cjk_regex = require("cjk-regex");

get_cjk_regex().test("a"); //=> false
get_cjk_regex().test(""); //=> true
get_cjk_regex().test(""); //=> true

get_cjk_regex.characters().test("a"); //=> false
get_cjk_regex.characters().test(""); //=> false
get_cjk_regex.characters().test(""); //=> true

get_cjk_regex.punctuations().test("a"); //=> false
get_cjk_regex.punctuations().test(""); //=> true
get_cjk_regex.punctuations().test(""); //=> false
const cjk = require("cjk-regex");

const cjk_charset = cjk();
cjk_charset.toRegExp().test("a"); //=> false
cjk_charset.toRegExp().test(""); //=> true
cjk_charset.toRegExp().test(""); //=> true

const cjk_letter_charset = cjk.letters();
cjk_letter_charset.toRegExp().test("a"); //=> false
cjk_letter_charset.toRegExp().test(""); //=> false
cjk_letter_charset.toRegExp().test(""); //=> true

const cjk_punctuaion_charset = cjk.punctuations();
cjk_punctuaion_charset.toRegExp().test("a"); //=> false
cjk_punctuaion_charset.toRegExp().test(""); //=> true
cjk_punctuaion_charset.toRegExp().test(""); //=> false
```

Return a [Charset](https://github.com/ikatyang/regexp-util#charset).

## Development

```sh
Expand Down

0 comments on commit d87ae92

Please sign in to comment.