![Namecheap Takes Down Polyfill.io Service Following Supply Chain Attack](https://cdn.sanity.io/images/cgdhsj6q/production/6af25114feaaac7179b18127c83327568ff592d1-1024x1024.webp?w=800&fit=max&auto=format)
Security News
Namecheap Takes Down Polyfill.io Service Following Supply Chain Attack
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
sort-array
Advanced tools
Readme
Isomorphic, load-anywhere function to sort an array by scalar, deep or computed values in any standard or custom order.
const sortArray = require('sort-array')
Sort an array of primitives, for example strings.
> const partsOfTheDay = ['twilight', 'afternoon', 'morning', 'evening']
> sortArray(partsOfTheDay)
[ 'afternoon', 'evening', 'morning', 'twilight' ]
The default sort order is asc
. You can also specify desc
or the name of a property from the customOrders
object. For example, sort parts of the day by the order in which they occur.
> sortArray(partsOfTheDay, {
order: 'time',
customOrders: {
time: ['morning', 'afternoon', 'evening', 'twilight']
}
})
[ 'morning', 'afternoon', 'evening', 'twilight' ]
Sort by a computed field, i.e. a computed value that doesn't exist in the input dataset. Define your computed fields in the options.computed
object, each value being a function which takes an array member as input and returns the primitive value to be sorted by. In this example we sort by total
(the name of the computed field supplied in options.computed
).
> const repositories = [
{ name: '75lb/sort-array', openIssues: 0, closedIssues: 4 },
{ name: 'lwsjs/local-web-server', openIssues: 4, closedIssues: 80 },
{ name: 'jsdoc2md/jsdoc-api', openIssues: 3, closedIssues: 47 }
]
> sortArray(repositories, {
by: 'total',
order: 'desc',
computed: {
total: repository => repository.openIssues + repository.closedIssues
}
})
[
{ name: 'lwsjs/local-web-server', openIssues: 4, closedIssues: 80 },
{ name: 'jsdoc2md/jsdoc-api', openIssues: 3, closedIssues: 47 },
{ name: '75lb/sort-array', openIssues: 0, closedIssues: 4 }
]
You can use computed fields to sort by values deep in an object structure.
> const data = [
{ inner: { number: 2 } },
{ inner: { number: 3 } },
{ inner: { number: 1 } }
]
> sortArray(data, {
by: 'number',
computed: {
number: row => row.inner.number
}
})
[
{ inner: { number: 1 } },
{ inner: { number: 2 } },
{ inner: { number: 3 } }
]
Sort by multiple columns using multiple custom orders.
> const attributes = [
{ skill: 'accuracy', confidence: 'medium' },
{ skill: 'power', confidence: 'high' },
{ skill: 'speed', confidence: 'low' },
{ skill: 'power', confidence: 'low' },
{ skill: 'speed', confidence: 'high' },
{ skill: 'accuracy', confidence: 'low' },
{ skill: 'speed', confidence: 'medium' },
{ skill: 'accuracy', confidence: 'high' },
{ skill: 'power', confidence: 'medium' }
]
> sortArray(attributes, {
by: ['skill', 'confidence'],
order: ['skill', 'confidence'],
customOrders: {
skill: ['accuracy', 'speed', 'power'],
confidence: ['low', 'medium', 'high'],
}
})
[
{ skill: 'accuracy', confidence: 'low' },
{ skill: 'accuracy', confidence: 'medium' },
{ skill: 'accuracy', confidence: 'high' },
{ skill: 'speed', confidence: 'low' },
{ skill: 'speed', confidence: 'medium' },
{ skill: 'speed', confidence: 'high' },
{ skill: 'power', confidence: 'low' },
{ skill: 'power', confidence: 'medium' },
{ skill: 'power', confidence: 'high' }
]
Please visit the sort-array wiki for more examples.
Isomorphic, load-anywhere function to sort an array by scalar, deep or computed values in any standard or custom order.
Example
const sortArray = require('sort-array')
Array
⏏Kind: Exported function
Returns: Array
- Returns the array that was passed in.
Param | Type | Description |
---|---|---|
array | Array | The input array to sort. It is sorted in place. |
[options] | object | Sort options. |
[options.by] | Array.<string> | One or more property names or computed fields to sort by. Specifying property names is only relevant when sorting an array of objects. |
[options.order] | Array.<string> | One or more sort orders. Specify asc , desc or a property name from the options.customOrders object. |
[options.customOrders] | object | A dictionary object containing one or more custom orders. Each custom order value must be an array defining the order expected values must be sorted in. |
[options.computed] | object | A dictionary object containing one or more computed field functions. The function will be invoked once per item in the array. Each invocation will receive the array item as input and must return a primitive value by which the array can be sorted. |
This library is compatible with Node.js, the Web and any style of module loader. It can be loaded anywhere, natively without transpilation.
Node.js:
const arrayify = require('sort-array')
Within Node.js with ECMAScript Module support enabled:
import arrayify from 'sort-array'
Within an modern browser ECMAScript Module:
import arrayify from './node_modules/sort-array/dist/index.mjs'
Old browser (adds window.sortArray
):
<script nomodule src="./node_modules/sort-array/dist/index.js"></script>
© 2015-19 Lloyd Brookes <75pound@gmail.com>. Documented by jsdoc-to-markdown.
FAQs
Isomorphic, load-anywhere function to sort an array by scalar, deep or computed values in any standard or custom order
The npm package sort-array receives a total of 122,246 weekly downloads. As such, sort-array popularity was classified as popular.
We found that sort-array demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.
Security News
A JavaScript library maintainer is under fire after merging a controversial PR to support legacy versions of Node.js.