Security News
Combatting Alert Fatigue by Prioritizing Malicious Intent
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
@smakss/search
Advanced tools
Enhance your searching capabilities with @smakss/search. Effortlessly find keywords in arrays, nested arrays, and objects, perfect for deep search needs in various data structures.
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.
Explore the live demonstration available on CodeSandbox:
To install the package:
npm i @smakss/search
# or
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
.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] });
// Results: [{ name: 'John', lastName: 'Doe' }]
const arr = [
{ name: 'John', lastName: 'Doe' },
{ name: 'Joe', lastName: 'Doe' }
];
const results = Search({ searchText: 'john', searchItems: arr });
// Results: [{ name: 'John', lastName: 'Doe' }]
const nestedArr = [
{ name: 'John', lastName: 'Doe' },
{ name: 'Joe', lastName: 'Doe' },
[{ name: 'Jane', lastName: 'Doe' }]
];
const results = Search({ searchText: 'jane', searchItems: nestedArr });
// Results: [{ name: 'Jane', lastName: 'Doe' }]
const results = Search({
searchText: 'jane',
searchItems: nestedArr,
keys: ['name']
});
// Results: [{ name: 'Jane', lastName: 'Doe' }]
const results = Search({
searchText: 'jane',
searchItems: nestedArr,
keys: ['lastName'],
include: false
});
// Results: []
Note: The result is an empty array because 'lastName' is excluded from the search.
const results = Search({
searchText: 'jane',
searchItems: nestedArr,
exact: true
});
// Results: [{ name: 'Jane', lastName: 'Doe' }]
Note: Only the exact term 'Jane' is matched, not 'Janet' or other partial matches.
Interested in contributing to this project? Please refer to CONTRIBUTING.md for contribution guidelines.
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.
FAQs
Enhance your searching capabilities with @smakss/search. Effortlessly find keywords in arrays, nested arrays, and objects, perfect for deep search needs in various data structures.
The npm package @smakss/search receives a total of 64 weekly downloads. As such, @smakss/search popularity was classified as not popular.
We found that @smakss/search demonstrated a healthy version release cadence and project activity because the last version was released less than 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
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.