fulltext-search-kit

• A utility library for full-text search in TypeScript.
• I have no intention of removing this package until npm ceases to exist.

Features

• Full-text search functionality
• Supports multiple search requirements
• Handles special character removal
• Optimized for Korean text
• 한국어 초성 검색도 지원합니다.

Live Demo

demo

Installation

You can install the library using npm:

npm install fulltext-search-kit

or using yarn:

yarn add fulltext-search-kit

Usage

Importing the Library

To use the library, import the returnFullTextSearchFilteredData function:

import { returnFullTextSearchFilteredData } from 'fulltext-search-kit';

Example Here is a simple example demonstrating how to use the returnFullTextSearchFilteredData function:

const data = [
  { name: 'John Doe01012', age: 30, phoneNumber: '010-2345-7890' },
  { name: 'Jane Smith01023', age: 25, phoneNumber: '010-1234-5678' },
  { name: 'Alice Johnson01023', age: 35, phoneNumber: '010-5500-4455' },
];

const searchRequirement = [
  { value: 'name' },
  { value: 'phoneNumber', removeCharacters: '-' },
];
const searchFilterText = 'Jane';
// const searchFilterText = '010123';

const filteredData = returnFullTextSearchFilteredData<T>({
  data,
  searchRequirement,
  searchFilterText,
});

console.log(filteredData);

API

returnFullTextSearchFilteredData

Filters an array of objects based on the search requirements and filter text.

Parameters

• data (Array): The data to search through.
• searchRequirement (Array<{ value: string; removeCharacters?: string; }>): The requirements for the search.

  text: 010-0000-0000,
  removeCharacters: '-'
  return: 01000000000

• searchFilterText (string): The text to filter the data by.

Returns

• Array: The filtered data.

Internal Functions

fullTextSearchCore

• Core function for full-text search logic. This function is used internally by returnFullTextSearchFilteredData.

escapeRegExp

• Escapes special characters in a string for use in a regular expression.

characterPatternCheckerCore

• Checks and returns a pattern for Korean characters.

createInitialLetterMatcher

• Creates a regular expression matcher for initial Korean letters.

Contributing

• Contributions are welcome!

License

• This project is licensed under the MIT License - see the LICENSE file for details.

Author

ByungHyunWoo(KR)