From 26105034da4fcce7ac883c899d781f016559310d Mon Sep 17 00:00:00 2001 From: ruki Date: Thu, 8 Nov 2018 00:38:48 +0800 Subject: switch to vuepress --- node_modules/alphanum-sort/README.md | 45 ++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 node_modules/alphanum-sort/README.md (limited to 'node_modules/alphanum-sort/README.md') 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 +[![Build Status](https://travis-ci.org/TrySound/alphanum-sort.svg?branch=master)](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) -- cgit v1.2.3