Search
Searching through arrays, nested arrays, or objects for specific keywords can often be cumbersome, especially when dealing with deeply nested structures. This package simplifies that process by offering a lightweight, flexible search utility that delves into every key of an object or array elements to find matches. It utilizes ES6+ syntax, so if your codebase uses older standards, a transpiler might be required.
Demo
Explore the live demonstration available on CodeSandbox:
How it works?
To install the package:
npm i @smakss/search
yarn add @smakss/search
For CommonJS modules:
const Search = require('@smakss/search');
For ECMAScript modules:
import Search from '@smakss/search';
Then, to utilize the search function within your application:
The Search
function accepts an options object with the following properties:
searchText
(String
): The string to search for.searchItems
(Array|Object
): The items or structure to search within.keys
(Array
): An array of keys to include or exclude from the search.include
(Boolean
): Determines whether to include (true
) or exclude (false
) the keys specified. Defaults to true
.exact
(Boolean
): Determines whether to perform an exact match search. Defaults to false
.
Examples of Usage
Searching Within an Object
When the match is found in an object, the entire object is returned:
const obj = { name: 'John', lastName: 'Doe' };
const results = Search({ searchText: 'john', searchItems: [obj] });
Searching Within an Array
const arr = [
{ name: 'John', lastName: 'Doe' },
{ name: 'Joe', lastName: 'Doe' }
];
const results = Search({ searchText: 'john', searchItems: arr });
Searching Within a Nested Array
const nestedArr = [
{ name: 'John', lastName: 'Doe' },
{ name: 'Joe', lastName: 'Doe' },
[{ name: 'Jane', lastName: 'Doe' }]
];
const results = Search({ searchText: 'jane', searchItems: nestedArr });
Including Specific Keys
const results = Search({
searchText: 'jane',
searchItems: nestedArr,
keys: ['name']
});
Excluding Specific Keys
const results = Search({
searchText: 'jane',
searchItems: nestedArr,
keys: ['lastName'],
include: false
});
Note: The result is an empty array because 'lastName' is excluded from the search.
Performing an Exact Match Search
const results = Search({
searchText: 'jane',
searchItems: nestedArr,
exact: true
});
Note: Only the exact term 'Jane' is matched, not 'Janet' or other partial matches.
Contributing
Interested in contributing to this project? Please refer to CONTRIBUTING.md for contribution guidelines.
Code of Conduct
Our community prioritizes the well-being and inclusivity of all contributors and users. Please review our Code of Conduct to help maintain a supportive environment for everyone.