Blame view

node_modules/sort-keys/readme.md 1002 Bytes
aaac7fed   liuqimichale   add
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
  # sort-keys [![Build Status](https://travis-ci.org/sindresorhus/sort-keys.svg?branch=master)](https://travis-ci.org/sindresorhus/sort-keys)
  
  > Sort the keys of an object
  
  Useful to get a deterministically ordered object, as the order of keys can vary between engines.
  
  
  ## Install
  
  ```
  $ npm install --save sort-keys
  ```
  
  
  ## Usage
  
  ```js
  const sortKeys = require('sort-keys');
  
  sortKeys({c: 0, a: 0, b: 0});
  //=> {a: 0, b: 0, c: 0}
  
  sortKeys({b: {b: 0, a: 0}, a: 0}, {deep: true});
  //=> {a: 0, b: {a: 0, b: 0}}
  
  sortKeys({c: 0, a: 0, b: 0}, {
  	compare: (a, b) => -a.localeCompare(b)
  });
  //=> {c: 0, b: 0, a: 0}
  ```
  
  
  ## API
  
  ### sortKeys(input, [options])
  
  Returns a new object with sorted keys.
  
  #### input
  
  Type: `Object`
  
  #### options
  
  ##### deep
  
  Type: `boolean`
  
  Recursively sort keys.
  
  ##### compare
  
  Type: `Function`
  
  [Compare function.](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort)
  
  
  ## License
  
  MIT © [Sindre Sorhus](https://sindresorhus.com)