Text Search Engine

A text search engine that supports mixed Chinese and English fuzzy search

Overview

中文 README

A dynamic programming-based text search engine that supports mixed Chinese and English fuzzy search, returning the highest-weight matching results.

Who use it?

• Blazwitcher: A Chrome Extension For Searching and Switcher in Blazing Speed

Online Demo

Check out this online demo if you are interested.

Installation

npm i text-search-engine

Supported Environments

Supports both Node.js and Web environments.

Usage

search

Pure English Search

import { search } from 'text-search-engine'

const source = 'nonode'

search(source, 'no') //[[0, 1]]
// Matches 'no', continuous characters have higher weight
search(source, 'nod') // [[2, 4]]
search(source, 'noe') // [[0, 1], [5, 5]]
search(source, 'oo') // [[1, 1],[3, 3]]

search('nonode', 'noe') Match result: nonode

Pure Chinese Search

import { search } from 'text-search-engine'

const source = '地表最强前端监控平台'

search(source, 'jk') // [[6, 7]]
search(source, 'qianduapt') // [[4, 5],[8, 9]]

search('地表最强前端监控平台', 'qianduapt') Match result: 地表最强前端监控平台

Mixed Chinese and English Search

import { search } from 'text-search-engine'

search('Node.js 最强监控平台 V9', 'nodejk') //[[0, 3],[10, 11]]

const source_2 = 'a_nd你你的就是我的'
search(source_2, 'nd') //[[2, 3]]
// Matches '你你的'
search(source_2, 'nnd') //[[4, 6]]
// Matches 'a_'n'd你你的就'是我的'
search(source_2, 'nshwode') //[[2, 2],[8, 10]]

search('Node.js 最强监控平台 V9', 'nodejk') Match result: Node.js 最强监控平台 V9

Space-separated Search

Adding spaces makes each term independent. Each term starts matching from the beginning, and matched terms will be removed, so the next term starts matching from the beginning and ignores previously matched terms.

const source_1 = 'Node.js 最强监控平台 V9'

search(source_1, 'jknode') // undefined
search(source_1, 'jk node') // [[10, 11],[0, 3]]

search('Node.js 最强监控平台 V9', 'jk node') Match result: Node.js 最强监控平台 V9

Sort of Backtracking

const source_1 = 'zxhxo zhx'
search(source_1, 'zh') //[[6, 7]])
// Even though the weight of 'zh' is higher, but the next term 'o' is not matched, so hit the previous one
search(source_1, 'zho') //[[0, 0],[2, 2],[4, 4]])

highlightMatches

This API is used for quickly validating text match highlights. It returns ANSI escape codes that can be output using console.log in both Web and Node.js environments to see the highlighted text.

import { highlightMatches } from 'text-search-engine'
console.log(highlightMatches('Node.js 最强监控平台 V9', 'nodev9'))

The console will output: Node.js 最强监控平台 V9

options

Option Name	Default Value	Description & Example
mergeSpaces	true	Whether to merge spaces between matched items. When set to true, it will merge spaces in the middle of matched results into consecutive index ranges. search('chrome 应用商店', 'meyinyon',{ mergeSpaces: false }) returns [[4, 5], [7, 8]] search('chrome 应用商店', 'meyinyon', { mergeSpaces: true }) returns [[4, 8]]
strictnessCoefficient	undefined	Strictness coefficient to control the strictness of matching. When a numeric value is set, if the number of matched characters is less than or equal to Math.ceil(query length * coefficient), it returns the result, otherwise returns undefined. search('Node.js 最强监控平台 V8', 'nozjk') returns [[0, 1], [8, 8], [10, 11]] search('Node.js 最强监控平台 V8', 'nozjk', { strictnessCoefficient: 0.5 }) returns [[0, 1], [8, 8], [10, 11]] search('Node.js 最强监控平台 V8', 'nozjk', { strictnessCoefficient: 0.4 }) returns undefined
isCharConsecutive	false	Controls whether matched characters need to be consecutive in the source string. When set to true, it requires matched characters to be consecutive in the source string (Chinese and English do not need to be consecutive). search('Chinese@中国 People-人', 'chie') returns [[0, 2], [4, 4]] search('Chinese@中国 People-人', 'chie', { isCharConsecutive: true }) returns undefined search('Chinese@中国 People-人', '中ple', { isCharConsecutive: true }) returns [[8, 8], [14, 16]]
strictCase	false	Controls case-sensitive matching. When set to true, the search will match exact case. When set to false, the search will be case-insensitive. search('Hello World', 'hello') returns [[0, 4]] search('Hello World', 'hello', { strictCase: true }) returns undefined search('Hello World', 'hello', { strictCase: false }) returns [[0, 4]]

React Component

Take a look at CodeSandbox Online Demo

HighlightWithTarget

import { HighlightWithTarget } from 'text-search-engine/react'

function Test() {
    return <HighlightWithTarget source='Node.js 最强监控平台 V9' target='nodejk' />
}

HighlightWithRange

import { HighlightWithRanges } from 'text-search-engine/react'
import { search } from 'text-search-engine'

export default function DemoForHighlightWithTarget() {
	const ranges = search('Node.js 最强监控平台 V9', 'nodejk')
	return <HighlightWithRanges source='Node.js 最强监控平台 V9' hitRanges={ranges}  />
}

Performance

	Time Complexity	Space Complexity
Best	O(M(source))	O(M(source))
Worst	O(M(source) * N(target))	O(M(source) * N(target))

Contributing

Please see the contributing guidelines to learn more.

A big thanks to all of our amazing contributors ❤️

Feel free to join the fun and send a PR!

📞 contact

welcome to raise issue, you can contact me on wx or email if you have some good suggestion(notes: text-search-engine)

• wx: cjinhuo
• email: cjinhuo@qq.com