Blame view

node_modules/stable/README.md 2.73 KB
f7563de62   Palak Handa   first commit
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
  ## Stable
  
  A stable array sort, because `Array#sort()` is not guaranteed stable.
  
  MIT licensed.
  
  [![Node.js CI](https://secure.travis-ci.org/Two-Screen/stable.png)](http://travis-ci.org/Two-Screen/stable)
  
  [![Browser CI](http://ci.testling.com/Two-Screen/stable.png)](http://ci.testling.com/Two-Screen/stable)
  
  #### From the browser
  
  Include [`stable.js`] or the minified version [`stable.min.js`]
  in your page, then call `stable()`.
  
   [`stable.js`]: https://raw.github.com/Two-Screen/stable/master/stable.js
   [`stable.min.js`]: https://raw.github.com/Two-Screen/stable/master/stable.min.js
  
  #### From Node.js
  
  Install using NPM:
  
      npm install stable
  
  Require in your code:
  
      var stable = require("stable");
  
  #### Usage
  
  The default sort is, as with `Array#sort`, lexicographical:
  
      stable(["foo", "bar", "baz"]);   // => ["bar", "baz", "foo"]
      stable([10, 1, 5]);              // => [1, 10, 5]
  
  Unlike `Array#sort`, the default sort is **NOT** in-place. To do an in-place
  sort, use `stable.inplace`, which otherwise works the same:
  
      var arr = [10, 1, 5];
      stable(arr) === arr;            // => false
      stable.inplace(arr) === arr;    // => true
  
  A comparator function can be specified:
  
      // Regular sort() compatible comparator, that returns a number.
      // This demonstrates the default behavior.
      function lexCmp(a, b) {
          return String(a).localeCompare(b);
      }
      stable(["foo", "bar", "baz"], lexCmp);   // => ["bar", "baz", "foo"]
  
      // Boolean comparator. Sorts `b` before `a` if true.
      // This demonstrates a simple way to sort numerically.
      function greaterThan(a, b) {
          return a > b;
      }
      stable([10, 1, 5], greaterThan);  // -> [1, 5, 10]
  
  #### License
  
  Copyright (C) 2017 Angry Bytes and contributors.
  
  Permission is hereby granted, free of charge, to any person obtaining a copy of
  this software and associated documentation files (the "Software"), to deal in
  the Software without restriction, including without limitation the rights to
  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
  of the Software, and to permit persons to whom the Software is furnished to do
  so, subject to the following conditions:
  
  The above copyright notice and this permission notice shall be included in all
  copies or substantial portions of the Software.
  
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  SOFTWARE.