first commit
This commit is contained in:
205
node_modules/sortobject/README.md
generated
vendored
Normal file
205
node_modules/sortobject/README.md
generated
vendored
Normal file
@@ -0,0 +1,205 @@
|
||||
<!-- TITLE/ -->
|
||||
|
||||
<h1>Sort Object</h1>
|
||||
|
||||
<!-- /TITLE -->
|
||||
|
||||
|
||||
<!-- BADGES/ -->
|
||||
|
||||
<span class="badge-travisci"><a href="http://travis-ci.com/bevry/sortobject" title="Check this project's build status on TravisCI"><img src="https://img.shields.io/travis/com/bevry/sortobject/master.svg" alt="Travis CI Build Status" /></a></span>
|
||||
<span class="badge-npmversion"><a href="https://npmjs.org/package/sortobject" title="View this project on NPM"><img src="https://img.shields.io/npm/v/sortobject.svg" alt="NPM version" /></a></span>
|
||||
<span class="badge-npmdownloads"><a href="https://npmjs.org/package/sortobject" title="View this project on NPM"><img src="https://img.shields.io/npm/dm/sortobject.svg" alt="NPM downloads" /></a></span>
|
||||
<span class="badge-daviddm"><a href="https://david-dm.org/bevry/sortobject" title="View the status of this project's dependencies on DavidDM"><img src="https://img.shields.io/david/bevry/sortobject.svg" alt="Dependency Status" /></a></span>
|
||||
<span class="badge-daviddmdev"><a href="https://david-dm.org/bevry/sortobject#info=devDependencies" title="View the status of this project's development dependencies on DavidDM"><img src="https://img.shields.io/david/dev/bevry/sortobject.svg" alt="Dev Dependency Status" /></a></span>
|
||||
<br class="badge-separator" />
|
||||
<span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
|
||||
<span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span>
|
||||
<span class="badge-liberapay"><a href="https://liberapay.com/bevry" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a></span>
|
||||
<span class="badge-buymeacoffee"><a href="https://buymeacoffee.com/balupton" title="Donate to this project using Buy Me A Coffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg" alt="Buy Me A Coffee donate button" /></a></span>
|
||||
<span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span>
|
||||
<span class="badge-crypto"><a href="https://bevry.me/crypto" title="Donate to this project using Cryptocurrency"><img src="https://img.shields.io/badge/crypto-donate-yellow.svg" alt="crypto donate button" /></a></span>
|
||||
<span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
|
||||
<span class="badge-wishlist"><a href="https://bevry.me/wishlist" title="Buy an item on our wishlist for us"><img src="https://img.shields.io/badge/wishlist-donate-yellow.svg" alt="Wishlist browse button" /></a></span>
|
||||
|
||||
<!-- /BADGES -->
|
||||
|
||||
|
||||
<!-- DESCRIPTION/ -->
|
||||
|
||||
Returns a copy of an object, sorted deeply by its keys, without mangling any arrays inside of it
|
||||
|
||||
<!-- /DESCRIPTION -->
|
||||
|
||||
|
||||
<!-- INSTALL/ -->
|
||||
|
||||
<h2>Install</h2>
|
||||
|
||||
<a href="https://npmjs.com" title="npm is a package manager for javascript"><h3>npm</h3></a>
|
||||
<ul>
|
||||
<li>Install: <code>npm install --save sortobject</code></li>
|
||||
<li>Require: <code>require('sortobject')</code></li>
|
||||
</ul>
|
||||
|
||||
<a href="https://jspm.io" title="Native ES Modules CDN"><h3>jspm</h3></a>
|
||||
|
||||
``` html
|
||||
<script type="module">
|
||||
import * as pkg from '//dev.jspm.io/sortobject'
|
||||
</script>
|
||||
```
|
||||
|
||||
<h3><a href="https://editions.bevry.me" title="Editions are the best way to produce and consume packages you care about.">Editions</a></h3>
|
||||
|
||||
<p>This package is published with the following editions:</p>
|
||||
|
||||
<ul><li><code>sortobject</code> aliases <code>sortobject/index.js</code> which uses <a href="https://editions.bevry.me" title="Editions are the best way to produce and consume packages you care about.">Editions</a> to automatically select the correct edition for the consumers environment</li>
|
||||
<li><code>sortobject/source/index.js</code> is esnext source code with require for modules</li>
|
||||
<li><code>sortobject/edition-browsers/index.js</code> is esnext compiled for browsers with require for modules</li>
|
||||
<li><code>sortobject/edition-node-0.12/index.js</code> is esnext compiled for node.js 0.12 with require for modules</li></ul>
|
||||
|
||||
<h3><a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a></h3>
|
||||
|
||||
This project provides its type information via inline <a href="http://usejsdoc.org" title="JSDoc is an API documentation generator for JavaScript, similar to Javadoc or phpDocumentor">JSDoc Comments</a>. To make use of this in <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a>, set your <code>maxNodeModuleJsDepth</code> compiler option to `5` or thereabouts. You can accomlish this via your `tsconfig.json` file like so:
|
||||
|
||||
``` json
|
||||
{
|
||||
"compilerOptions": {
|
||||
"maxNodeModuleJsDepth": 5
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
<!-- /INSTALL -->
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
[API Documentation.](http://master.sortobject.bevry.surge.sh/docs/)
|
||||
|
||||
```javascript
|
||||
var sortObject = require('sortobject')
|
||||
var fixture = {
|
||||
c: true,
|
||||
a: true,
|
||||
b: null,
|
||||
d: [
|
||||
{
|
||||
c: true,
|
||||
a: true,
|
||||
b: null
|
||||
},
|
||||
{
|
||||
c: true,
|
||||
a: true,
|
||||
b: null,
|
||||
d: [
|
||||
{
|
||||
c: true,
|
||||
a: true,
|
||||
b: null
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
var actual = sortObject(fixture)
|
||||
console.log(JSON.stringify(actual, null, 4)) /* {
|
||||
"a": true,
|
||||
"b": null,
|
||||
"c": true,
|
||||
"d": [
|
||||
{
|
||||
"a": true,
|
||||
"b": null,
|
||||
"c": true
|
||||
},
|
||||
{
|
||||
"a": true,
|
||||
"b": null,
|
||||
"c": true,
|
||||
"d": [
|
||||
{
|
||||
"a": true,
|
||||
"b": null,
|
||||
"c": true
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
} */
|
||||
```
|
||||
|
||||
<!-- HISTORY/ -->
|
||||
|
||||
<h2>History</h2>
|
||||
|
||||
<a href="https://github.com/bevry/sortobject/blob/master/HISTORY.md#files">Discover the release history by heading on over to the <code>HISTORY.md</code> file.</a>
|
||||
|
||||
<!-- /HISTORY -->
|
||||
|
||||
|
||||
<!-- CONTRIBUTE/ -->
|
||||
|
||||
<h2>Contribute</h2>
|
||||
|
||||
<a href="https://github.com/bevry/sortobject/blob/master/CONTRIBUTING.md#files">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a>
|
||||
|
||||
<!-- /CONTRIBUTE -->
|
||||
|
||||
|
||||
<!-- BACKERS/ -->
|
||||
|
||||
<h2>Backers</h2>
|
||||
|
||||
<h3>Maintainers</h3>
|
||||
|
||||
These amazing people are maintaining this project:
|
||||
|
||||
<ul><li><a href="http://balupton.com">Benjamin Lupton</a></li></ul>
|
||||
|
||||
<h3>Sponsors</h3>
|
||||
|
||||
These amazing people have contributed finances to this project:
|
||||
|
||||
<ul><li><a href="http://www.govests.com.au">GoVests</a></li></ul>
|
||||
|
||||
Become a sponsor!
|
||||
|
||||
<span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
|
||||
<span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span>
|
||||
<span class="badge-liberapay"><a href="https://liberapay.com/bevry" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a></span>
|
||||
<span class="badge-buymeacoffee"><a href="https://buymeacoffee.com/balupton" title="Donate to this project using Buy Me A Coffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg" alt="Buy Me A Coffee donate button" /></a></span>
|
||||
<span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span>
|
||||
<span class="badge-crypto"><a href="https://bevry.me/crypto" title="Donate to this project using Cryptocurrency"><img src="https://img.shields.io/badge/crypto-donate-yellow.svg" alt="crypto donate button" /></a></span>
|
||||
<span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
|
||||
<span class="badge-wishlist"><a href="https://bevry.me/wishlist" title="Buy an item on our wishlist for us"><img src="https://img.shields.io/badge/wishlist-donate-yellow.svg" alt="Wishlist browse button" /></a></span>
|
||||
|
||||
<h3>Contributors</h3>
|
||||
|
||||
These amazing people have contributed code to this project:
|
||||
|
||||
<ul><li><a href="http://balupton.com">Benjamin Lupton</a></li>
|
||||
<li><a href="sinewyk.com">Serge Havas</a></li>
|
||||
<li><a href="http://jameslnewell.me/">James Newell</a></li>
|
||||
<li><a href="http://jameslnewell.dev/">James Newell</a></li></ul>
|
||||
|
||||
<a href="https://github.com/bevry/sortobject/blob/master/CONTRIBUTING.md#files">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a>
|
||||
|
||||
<!-- /BACKERS -->
|
||||
|
||||
|
||||
<!-- LICENSE/ -->
|
||||
|
||||
<h2>License</h2>
|
||||
|
||||
Unless stated otherwise all works are:
|
||||
|
||||
<ul><li>Copyright © 2012+ <a href="http://bevry.me">Bevry Pty Ltd</a></li></ul>
|
||||
|
||||
and licensed under:
|
||||
|
||||
<ul><li><a href="http://spdx.org/licenses/MIT.html">MIT License</a></li></ul>
|
||||
|
||||
<!-- /LICENSE -->
|
||||
Reference in New Issue
Block a user