leven-sort   

Simply sort by similarity, starring Levenshtein via leven.

Allows sorting of an array of strings or array of objects by similarity. For arrays of objects
you can sort by up to two keys.

install

api

leven-sort only exports one function, but it has 3 distinct signatures

1. Sort simple text array
arrayToSort: Array to sort (sorted in place)
sourceText: The text to check similarity of

2. Sort array of objects, with optional secondary sort
arrayToSort: Array to sort (sorted in place)
sourceText1: The text to check similarity of
key1: Property name to be compared in each object
sourceText2 (optional): If performing a secondary sort, this is the text to check key2 by
key2 (optional): For secondary sort on object, this is the second property to check

3. Sort array of objects by multiple keys, each by the same source and with equal weight
arrayToSort: Array to sort (sorted in place)
sourceText: The text to check similarity of
arrayOfKeys: Array of property names to compare

usage

Sort simple text array
``javascript
const levenSort = require('leven-sort')
const sourceName = 'Bill Griffin'
const nameAry = [
'Carl Martinez',
'Roger Davis',
'William George',
'Andrew Torres',
'Billy Campbell',
'Alan King',
'Benjamin Wilson',
'Bill Griffin',
'Dennis Smith',
'Billy Griffith'
]
let levSorted = levenSort(nameAry, sourceName)
`

Sort array of objects, with secondary sort
`javascript
const levenSort = require('leven-sort')
const sourceFirst = 'Bill'
const sourceLast = 'Griffin'
const nameObjAry = [
{ first: 'Carl', last: 'Martinez' },
{ first: 'Roger', last: 'Davis' },
{ first: 'William', last: 'George' },
{ first: 'Andrew', last: 'Torres' },
{ first: 'Billy', last: 'Campbell' },
{ first: 'Alan', last: 'King' },
{ first: 'Benjamin', last: 'Wilson' },
{ first: 'Bill', last: 'Griffin' },
{ first: 'Dennis', last: 'Smith' },
{ first: 'Billy', last: 'Griffith' }
]

let levSorted = levenSort(nameObjAry, sourceFirst, 'first', sourceLast, 'last')

`

Sort array of objects by multiple keys
`javascript
const levenSort = require('leven-sort')
const source = 'Bill'
const nameObjAry = [
{ first: 'Carl', last: 'Martinez' },
{ first: 'Roger', last: 'Davis' },
{ first: 'William', last: 'George' },
{ first: 'Andrew', last: 'Torres' },
{ first: 'Billy', last: 'Campbell' },
{ first: 'Alan', last: 'King' },
{ first: 'Benjamin', last: 'Wilson' },
{ first: 'Bill', last: 'Griffin' },
{ first: 'Dennis', last: 'Smith' },
{ first: 'Billy', last: 'Griffith' }
]

let levSorted = levenSort(nameObjAry, source, ['first', 'last'])

``