1
0
mirror of https://github.com/nextapps-de/flexsearch.git synced 2025-09-25 04:51:29 +02:00

index.d.ts describe default export

This commit is contained in:
Thomas Wilkerling
2025-04-01 07:37:36 +02:00
parent 40f17691bf
commit 607300efe1
2 changed files with 25 additions and 16 deletions

39
index.d.ts vendored
View File

@@ -58,7 +58,7 @@ declare module "flexsearch" {
| "LatinAdvanced"
| "LatinExtra"
| "LatinSoundex"
| ((term: string) => string[]);
| ((content: string) => string[]);
/**
* **Document:**
@@ -141,17 +141,14 @@ declare module "flexsearch" {
char?: string|string[];
};
export type Charset = {
LatinExact: EncoderOptions;
LatinDefault: EncoderOptions;
LatinSimple: EncoderOptions;
LatinBalance: EncoderOptions;
LatinAdvanced: EncoderOptions;
LatinExtra: EncoderOptions;
LatinSoundex: EncoderOptions;
ArabicDefault: EncoderOptions;
CjkDefault: EncoderOptions;
CyrillicDefault: EncoderOptions;
export const Charset: {
Exact: EncoderOptions,
Default: EncoderOptions,
Normalize: EncoderOptions,
LatinBalance: EncoderOptions,
LatinAdvanced: EncoderOptions,
LatinExtra: EncoderOptions,
LatinSoundex: EncoderOptions
};
/**
@@ -190,7 +187,7 @@ declare module "flexsearch" {
commit?: boolean;
// Language-specific Options and Encoding
encoder?: Charset | Encoders | EncoderOptions;
encoder?: typeof Charset | Encoders | EncoderOptions;
encode?: (text: string) => string[],
rtl?: boolean;
};
@@ -339,8 +336,8 @@ declare module "flexsearch" {
type DocumentOptions = IndexOptions & {
worker?: boolean | WorkerURL | WorkerPath;
doc?: DocumentDescriptor | DocumentDescriptor[];
document?: DocumentDescriptor | DocumentDescriptor[];
doc?: DocumentDescriptor;
document?: DocumentDescriptor;
};
type DefaultDocumentSearchResults = Array<{
@@ -589,6 +586,18 @@ declare module "flexsearch" {
export class IndexedDB extends StorageInterface{
db: IDBDatabase
}
const FlexSearch: {
Index: typeof Index,
Document: typeof Document,
Worker: typeof Worker,
Encoder: typeof Encoder,
Charset: typeof Charset,
Resolver: typeof Resolver,
IndexedDB: typeof IndexedDB
}
export default FlexSearch;
}
// https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html

View File

@@ -2,7 +2,7 @@
"public": true,
"preferGlobal": false,
"name": "flexsearch",
"version": "0.8.147",
"version": "0.8.148",
"description": "Next-Generation full-text search library for Browser and Node.js",
"homepage": "https://github.com/nextapps-de/flexsearch/",
"author": "Thomas Wilkerling",