diff options
| author | ruki <waruqi@gmail.com> | 2018-11-08 00:38:48 +0800 |
|---|---|---|
| committer | ruki <waruqi@gmail.com> | 2018-11-07 21:53:09 +0800 |
| commit | 26105034da4fcce7ac883c899d781f016559310d (patch) | |
| tree | c459a5dc4e3aa0972d9919033ece511ce76dd129 /node_modules/alphanum-sort/README.md | |
| parent | 2c77f00f1a7ecb6c8192f9c16d3b2001b254a107 (diff) | |
| download | xmake-docs-26105034da4fcce7ac883c899d781f016559310d.tar.gz xmake-docs-26105034da4fcce7ac883c899d781f016559310d.zip | |
switch to vuepress
Diffstat (limited to 'node_modules/alphanum-sort/README.md')
| -rw-r--r-- | node_modules/alphanum-sort/README.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/node_modules/alphanum-sort/README.md b/node_modules/alphanum-sort/README.md new file mode 100644 index 00000000..506be21d --- /dev/null +++ b/node_modules/alphanum-sort/README.md @@ -0,0 +1,45 @@ +# alphanum-sort
+[](https://travis-ci.org/TrySound/alphanum-sort)
+
+> Alphanumeric sorting algorithm
+
+## Install
+
+With [npm](https://npmjs.org/package/alphanum-sort) do:
+
+```
+npm i alphanum-sort -S
+```
+
+## Example
+
+```js
+var sort = require('alphanum-sort');
+
+var result = sort(['item20', 'item19', 'item1', 'item10', 'item2']);
+// ['item1', 'item2', 'item10', 'item19', 'item20']
+```
+
+## API
+
+### alphanumSort(array, options)
+
+#### options
+
+##### insensitive
+
+Type: `Boolean`
+Default: `false`
+
+Compares items case insensitively
+
+##### sign
+
+Type: `Boolean`
+Default: `false`
+
+Allows `+` and `-` characters before numbers
+
+## License
+
+MIT © [Bogdan Chadkin](https://github.com/trysound)
|