UNPKG

@isdk/kvsqlite

Version:

[![npm version](https://img.shields.io/npm/v/@isdk/kvsqlite.svg)](https://www.npmjs.com/package/@isdk/kvsqlite) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

github.com/isdk/kvsqlite.js

isdk/kvsqlite.js

85 lines (43 loc) • 2.65 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
[**@isdk/kvsqlite**](../README.md) *** [@isdk/kvsqlite](../globals.md) / IKVCreateFtsOptions # Interface: IKVCreateFtsOptions Defined in: [packages/kvsqlite/src/consts.ts:126](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/consts.ts#L126) Represents options for creating an FTS (Full-Text Search) table in SQLite with additional support for multiple languages and plugins. ## Properties ### exclude? > `optional` **exclude**: `string`[] Defined in: [packages/kvsqlite/src/consts.ts:134](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/consts.ts#L134) Lists fields to be excluded from full-text search. *** ### fields? > `optional` **fields**: `string`[] Defined in: [packages/kvsqlite/src/consts.ts:144](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/consts.ts#L144) *** ### include? > `optional` **include**: `string`[] Defined in: [packages/kvsqlite/src/consts.ts:138](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/consts.ts#L138) Specifies fields that should be indexed in the FTS table. *** ### language? > `optional` **language**: `string` \| [`IKVCreateFtsLanguageOptions`](IKVCreateFtsLanguageOptions.md) Defined in: [packages/kvsqlite/src/consts.ts:148](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/consts.ts#L148) Configures the language for full-text search. *** ### prefix? > `optional` **prefix**: `string` Defined in: [packages/kvsqlite/src/consts.ts:143](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/consts.ts#L143) Configures prefix matching behavior. *** ### skipIndexed? > `optional` **skipIndexed**: `boolean` Defined in: [packages/kvsqlite/src/consts.ts:158](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/consts.ts#L158) Control Inclusion of Indexed Fields in FTS Indexing * When skipIndexed is set to true, fields that are already indexed will be automatically excluded from the FTS (Full-Text Search) indexing process by adding them to the unindexed list. * When set to false, this behavior is disabled, and all specified fields will be included in the FTS indexing process regardless of whether they are already indexed. defaults to `true` *** ### unIndexed? > `optional` **unIndexed**: `string`[] Defined in: [packages/kvsqlite/src/consts.ts:130](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/consts.ts#L130) Specifies fields that should not be indexed in the FTS table.