mirror_js/flexsearch
1
0
Fork 0
mirror of https://github.com/nextapps-de/flexsearch.git synced 2025-08-31 17:42:13 +02:00
Code Issues Releases Wiki Activity

add exports to index.d.ts

Browse Source
This commit is contained in:
Thomas Wilkerling
2025-05-07 18:10:10 +02:00
parent 1a0bd73002
commit 650cf81d9e
2 changed files with 88 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
test/types.ts
View File

@@ -5,26 +5,29 @@ import {
Worker,
Resolver,
StorageInterface,
DefaultSearchResults,
} from "flexsearch";
import "../index";
async function test() {
const document = new Document<{
title: string
description: string
tags: {
name: string
id: number
}[]
id: number,
title: string,
description: string,
tags: string[]
}>({
document: {
index: [ "tags" ],
id: "id",
index: [ "title", "description" ],
tag: [ "tags" ],
store: [ "title", "description" ]
},
});
// The correct type
const doc1 = await document.searchAsync({});
const doc2: Resolver = await document.searchAsync({
resolve: true,
resolve: false,
});
const doc3 = await document.searchAsync({
enrich: true,
@@ -34,14 +37,46 @@ async function test() {
merge: true,
});
doc4[0].doc.title;
// The wrong type
const t_1_1: DefaultSearchResults = document.search("test", { pluck: "title" });
// @ts-expect-error
const docw1: Resolver = await document.searchAsync({});
const t_1_2: DefaultSearchResults = document.search("test", {});
const t_2_1: DefaultDocumentSearchResults = document.search("test", {});
// @ts-expect-error
const docw2: DefaultDocumentSearchResults = await document.searchAsync({
enrich: true,
});
const t_2_2: DefaultSearchResults = document.search("test", {});
const t_3_1: DefaultDocumentSearchResults = document.search({});
const t_3_2: DefaultDocumentSearchResults = document.search({ resolve: true });
const t_4_1: Resolver = document.search({ resolve: false });
const t_4_2: Resolver = new Resolver();
// @ts-expect-error
const t_4_3: Resolver = document.search({});
// @ts-expect-error
const t_4_4: Resolver = document.search({ resolve: true });
// @ts-expect-error
const docw6: DefaultDocumentSearchResults = await document.searchAsync({});
// @ts-expect-error
const docw7: DefaultDocumentSearchResults = await document.searchAsync({ pluck: false });
// @ts-expect-error
const docw8: DefaultDocumentSearchResults = await document.searchAsync({ enrich: false });
// @ts-expect-error
const docw4: Resolver = await document.searchAsync({});
// @ts-expect-error
const docw5: Resolver = await document.searchAsync({ resolve: true });
// @ts-expect-error
const docw6: DefaultDocumentSearchResults = await document.searchAsync({});
// @ts-expect-error
const docw7: DefaultDocumentSearchResults = await document.searchAsync({ pluck: false });
// @ts-expect-error
const docw8: DefaultDocumentSearchResults = await document.searchAsync({ enrich: false });
// Promise?
const documentNoWorker = new Document({});
const doc5 = documentNoWorker.search({}); // No Promise