Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@smakss/search

Package Overview
Dependencies
Maintainers
1
Versions
44
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@smakss/search

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.

  • 2.0.1-beta.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
33
decreased by-71.79%
Maintainers
1
Weekly downloads
 
Created
Source

npm NPM npm npm bundle size (scoped)

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:

View @smakss/search

How it works?

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.

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] });
// Results: [{ name: 'John', lastName: 'Doe' }]

Searching Within an Array

const arr = [
  { name: 'John', lastName: 'Doe' },
  { name: 'Joe', lastName: 'Doe' }
];

const results = Search({ searchText: 'john', searchItems: arr });
// Results: [{ name: 'John', lastName: 'Doe' }]

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 });
// Results: [{ name: 'Jane', lastName: 'Doe' }]

Including Specific Keys

const results = Search({
  searchText: 'jane',
  searchItems: nestedArr,
  keys: ['name']
});
// Results: [{ name: 'Jane', lastName: 'Doe' }]

Excluding Specific Keys

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.

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.

Keywords

FAQs

Package last updated on 31 Dec 2023

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc