Options | MiniSearch (original) (raw)

Options<T>: {
autoSuggestOptions?: SearchOptions;
autoVacuum?: boolean | AutoVacuumOptions;
extractField?: ((document, fieldName) => any);
fields: string[];
idField?: string;
logger?: ((level, message, code?) => void);
processTerm?: ((term, fieldName?) => string | string[] | null | undefined | false);
searchOptions?: SearchOptions;
storeFields?: string[];
stringifyField?: ((fieldValue, fieldName) => string);
tokenize?: ((text, fieldName?) => string[]);
}

Type Parameters

• T = any

Type declaration

• Optional autoSuggestOptions?: SearchOptions

• Optional autoVacuum?: boolean | AutoVacuumOptions

• Optional extractField?: ((document, fieldName) => any)

  • • Parameters

             * document: [T](MiniSearch.Options.html#T)  
             * fieldName: string  

      Returns any

• fields: string[]

• Optional idField?: string

• Optional logger?: ((level, message, code?) => void)

  • • (level, message, code?): void

      • Parameters

           * level: LogLevel  
           * message: string  
           * `Optional` code: string

      Returns void

• Optional processTerm?: ((term, fieldName?) => string | string[] | null | undefined | false)

  • • (term, fieldName?): string | string[] | null | undefined | false

      • Parameters

           * term: string  
           * `Optional` fieldName: string

      Returns string | string[] | null | undefined | false

• Optional searchOptions?: SearchOptions

• Optional storeFields?: string[]

• Optional stringifyField?: ((fieldValue, fieldName) => string)

  • • (fieldValue, fieldName): string

      • Parameters

           * fieldValue: any  
           * fieldName: string

      Returns string

• Optional tokenize?: ((text, fieldName?) => string[])

  • • (text, fieldName?): string[]

      • Parameters

           * text: string  
           * `Optional` fieldName: string

      Returns string[]