fuzzysearch

README

Fuzzy Search

Tiny and blazing-fast fuzzy search in Go

Installation

go get codeberg.org/chensl/fuzzysearch

Examples

package main

import (
	"fmt"

	"codeberg.org/chensl/fuzzysearch"
)

func main() {
	elems := []string{"cartwheel", "foobar", "wheel", "baz"}
	pattern := "whl"

	fmt.Println(fuzzysearch.Find(elems, pattern))
	// Output: [wheel cartwheel]
}

Inspired by

• bevacqua/fuzzysearch
• Algorithm Implementation/Strings/Levenshtein distance

Documentation

Overview

Package fuzzysearch provides tiny and blazing-fast fuzzy search in Go

Index

• func Find(elems []string, pattern string) []string
• func Match(str, pattern string) bool

Examples

• Find
• Match

Functions

func Find

func Find(elems []string, pattern string) []string

Find returns all matches, sorted by levenshtein distance.

Example

elems := []string{"cartwheel", "foobar", "wheel", "baz"}
pattern := "whl"

fmt.Println(Find(elems, pattern))

Output:

[wheel cartwheel]

func Match

func Match(str, pattern string) bool

Match returns true if str matches pattern.

Example

fmt.Println(Match("cartwheel", "whl"))

Output:

true