0.2.0 • Published 5 years ago
@rveloz/list-rank v0.2.0
List Rank
A small library that orders a list of strings based on how early the query string appears in a string.
Installation
npm install @rveloz/list-rank
Usage
const listRank = require("@rveloz/list-rank");
const query = "fun";
const list = [
"Goodbye",
"Fundamental",
"I'm from Chicago",
"He's pretty funny",
"A fundraiser for church",
];
const orderedList = listRank(query, list);
Output should be:
[
"Fundamental",
"A fundraiser for church",
"He's pretty funny",
]
If the last argument is true:
const orderedList = listRank(query, list, true);
Output should be:
[
{
subject: "Fundamental",
position: 0,
},
{
subject: "A fundraiser for church",
position: 2,
},
{
subject: "He's pretty funny",
position: 12,
},
];
Tests
npm test