Nutmeg Plundering Muse

    @types/fuzzaldrin-plus
    TypeScript icon, indicating that this package has built-in type declarations

    0.6.2 • Public • Published

    Installation

    npm install --save @types/fuzzaldrin-plus

    Summary

    This package contains type definitions for fuzzaldrin-plus (https://github.com/jeancroy/fuzzaldrin-plus/).

    Details

    Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/fuzzaldrin-plus.

    index.d.ts

    // Type definitions for fuzzaldrin-plus 0.6.0
    // Project: https://github.com/jeancroy/fuzzaldrin-plus/
    // Definitions by:  Jean Christophe Roy <https://github.com/jeancroy>,
    //                  Jason Killian <https://github.com/jkillian>
    //                  Ronald Rey <https://github.com/reyronald>
    // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
    // TypeScript Version: 2.8
    
    export as namespace fuzzaldrin
    
    export class Query {
        $$__internal: Symbol
    }
    
    export interface IOptions {
        allowErrors?: boolean | undefined
        usePathScoring?: boolean | undefined
        useExtensionBonus?: boolean | undefined
        pathSeparator?: '/' | '\\' | string | undefined
        optCharRegEx?: RegExp | undefined
        wrap?: { tagOpen?: string | undefined; tagClass?: string | undefined; tagClose?: string | undefined } | undefined
        preparedQuery?: Query | undefined
    }
    
    export type IFilterOptions<T> = IOptions & {
        key?: T extends string ? never : keyof T | undefined
        maxResults?: number | undefined
        maxInners?: number | undefined
    }
    
    export function filter<T>(
        data: T[],
        query: string,
        options?: IFilterOptions<T>
    ): T[]
    export function score(str: string, query: string, options?: IOptions): number
    export function match(str: string, query: string, options?: IOptions): number[]
    export function wrap(str: string, query: string, options?: IOptions): string
    export function prepareQuery(query: string, options?: IOptions): Query

    Additional Details

    • Last updated: Thu, 08 Jul 2021 12:01:56 GMT
    • Dependencies: none
    • Global values: fuzzaldrin

    Credits

    These definitions were written by Jean Christophe Roy, Jason Killian, and Ronald Rey.

    Keywords

    none

    Install

    npm i @types/fuzzaldrin-plus

    DownloadsWeekly Downloads

    13,771

    Version

    0.6.2

    License

    MIT

    Unpacked Size

    5.94 kB

    Total Files

    4

    Last publish

    Collaborators

    • types