redis-type-os 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. package/CHANGELOG +168 -0
  2. package/LICENSE +22 -0
  3. package/README.md +1150 -0
  4. package/dist/index.d.ts +1398 -0
  5. package/dist/index.js +2047 -0
  6. package/docs/.nojekyll +1 -0
  7. package/docs/README.md +479 -0
  8. package/docs/classes/AbstractSearch.md +912 -0
  9. package/docs/classes/ArrayHashInput.md +198 -0
  10. package/docs/classes/Circle.md +375 -0
  11. package/docs/classes/Client.md +190 -0
  12. package/docs/classes/Field.md +254 -0
  13. package/docs/classes/FieldNotInSchema.md +198 -0
  14. package/docs/classes/InvalidHashInput.md +213 -0
  15. package/docs/classes/InvalidHashValue.md +228 -0
  16. package/docs/classes/InvalidInput.md +207 -0
  17. package/docs/classes/InvalidJsonInput.md +228 -0
  18. package/docs/classes/InvalidJsonValue.md +228 -0
  19. package/docs/classes/InvalidSchema.md +197 -0
  20. package/docs/classes/InvalidValue.md +203 -0
  21. package/docs/classes/NestedHashInput.md +198 -0
  22. package/docs/classes/NullJsonInput.md +228 -0
  23. package/docs/classes/NullJsonValue.md +228 -0
  24. package/docs/classes/PointOutOfRange.md +203 -0
  25. package/docs/classes/RawSearch.md +1063 -0
  26. package/docs/classes/RedisOmError.md +207 -0
  27. package/docs/classes/Repository.md +425 -0
  28. package/docs/classes/Schema.md +242 -0
  29. package/docs/classes/Search.md +1199 -0
  30. package/docs/classes/SearchError.md +201 -0
  31. package/docs/classes/SemanticSearchError.md +197 -0
  32. package/docs/classes/Where.md +43 -0
  33. package/docs/classes/WhereField.md +915 -0
  34. package/logo.svg +1 -0
  35. package/package.json +66 -0
package/docs/classes/SearchError.md ADDED
@@ -0,0 +1,201 @@
1
+ [redis-om](../README.md) / SearchError
2
+
3
+ # Class: SearchError
4
+
5
+ ## Hierarchy
6
+
7
+ - [`RedisOmError`](RedisOmError.md)
8
+
9
+ ↳ **`SearchError`**
10
+
11
+ ↳↳ [`SemanticSearchError`](SemanticSearchError.md)
12
+
13
+ ↳↳ [`FieldNotInSchema`](FieldNotInSchema.md)
14
+
15
+ ## Table of contents
16
+
17
+ ### Constructors
18
+
19
+ - [constructor](SearchError.md#constructor)
20
+
21
+ ### Properties
22
+
23
+ - [cause](SearchError.md#cause)
24
+ - [message](SearchError.md#message)
25
+ - [name](SearchError.md#name)
26
+ - [stack](SearchError.md#stack)
27
+ - [prepareStackTrace](SearchError.md#preparestacktrace)
28
+ - [stackTraceLimit](SearchError.md#stacktracelimit)
29
+
30
+ ### Methods
31
+
32
+ - [captureStackTrace](SearchError.md#capturestacktrace)
33
+
34
+ ## Constructors
35
+
36
+ ### constructor
37
+
38
+ • **new SearchError**(`message?`)
39
+
40
+ #### Parameters
41
+
42
+ | Name | Type |
43
+ | :------ | :------ |
44
+ | `message?` | `string` |
45
+
46
+ #### Inherited from
47
+
48
+ [RedisOmError](RedisOmError.md).[constructor](RedisOmError.md#constructor)
49
+
50
+ #### Defined in
51
+
52
+ node_modules/typescript/lib/lib.es5.d.ts:1059
53
+
54
+ • **new SearchError**(`message?`, `options?`)
55
+
56
+ #### Parameters
57
+
58
+ | Name | Type |
59
+ | :------ | :------ |
60
+ | `message?` | `string` |
61
+ | `options?` | `ErrorOptions` |
62
+
63
+ #### Inherited from
64
+
65
+ [RedisOmError](RedisOmError.md).[constructor](RedisOmError.md#constructor)
66
+
67
+ #### Defined in
68
+
69
+ node_modules/typescript/lib/lib.es2022.error.d.ts:30
70
+
71
+ ## Properties
72
+
73
+ ### cause
74
+
75
+ • `Optional` **cause**: `unknown`
76
+
77
+ #### Inherited from
78
+
79
+ [RedisOmError](RedisOmError.md).[cause](RedisOmError.md#cause)
80
+
81
+ #### Defined in
82
+
83
+ node_modules/typescript/lib/lib.es2022.error.d.ts:26
84
+
85
+ ___
86
+
87
+ ### message
88
+
89
+ • **message**: `string`
90
+
91
+ #### Inherited from
92
+
93
+ [RedisOmError](RedisOmError.md).[message](RedisOmError.md#message)
94
+
95
+ #### Defined in
96
+
97
+ node_modules/typescript/lib/lib.es5.d.ts:1054
98
+
99
+ ___
100
+
101
+ ### name
102
+
103
+ • **name**: `string`
104
+
105
+ #### Inherited from
106
+
107
+ [RedisOmError](RedisOmError.md).[name](RedisOmError.md#name)
108
+
109
+ #### Defined in
110
+
111
+ node_modules/typescript/lib/lib.es5.d.ts:1053
112
+
113
+ ___
114
+
115
+ ### stack
116
+
117
+ • `Optional` **stack**: `string`
118
+
119
+ #### Inherited from
120
+
121
+ [RedisOmError](RedisOmError.md).[stack](RedisOmError.md#stack)
122
+
123
+ #### Defined in
124
+
125
+ node_modules/typescript/lib/lib.es5.d.ts:1055
126
+
127
+ ___
128
+
129
+ ### prepareStackTrace
130
+
131
+ ▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
132
+
133
+ #### Type declaration
134
+
135
+ ▸ (`err`, `stackTraces`): `any`
136
+
137
+ Optional override for formatting stack traces
138
+
139
+ **`See`**
140
+
141
+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
142
+
143
+ ##### Parameters
144
+
145
+ | Name | Type |
146
+ | :------ | :------ |
147
+ | `err` | `Error` |
148
+ | `stackTraces` | `CallSite`[] |
149
+
150
+ ##### Returns
151
+
152
+ `any`
153
+
154
+ #### Inherited from
155
+
156
+ [RedisOmError](RedisOmError.md).[prepareStackTrace](RedisOmError.md#preparestacktrace)
157
+
158
+ #### Defined in
159
+
160
+ node_modules/@types/node/globals.d.ts:11
161
+
162
+ ___
163
+
164
+ ### stackTraceLimit
165
+
166
+ ▪ `Static` **stackTraceLimit**: `number`
167
+
168
+ #### Inherited from
169
+
170
+ [RedisOmError](RedisOmError.md).[stackTraceLimit](RedisOmError.md#stacktracelimit)
171
+
172
+ #### Defined in
173
+
174
+ node_modules/@types/node/globals.d.ts:13
175
+
176
+ ## Methods
177
+
178
+ ### captureStackTrace
179
+
180
+ ▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
181
+
182
+ Create .stack property on a target object
183
+
184
+ #### Parameters
185
+
186
+ | Name | Type |
187
+ | :------ | :------ |
188
+ | `targetObject` | `object` |
189
+ | `constructorOpt?` | `Function` |
190
+
191
+ #### Returns
192
+
193
+ `void`
194
+
195
+ #### Inherited from
196
+
197
+ [RedisOmError](RedisOmError.md).[captureStackTrace](RedisOmError.md#capturestacktrace)
198
+
199
+ #### Defined in
200
+
201
+ node_modules/@types/node/globals.d.ts:4
package/docs/classes/SemanticSearchError.md ADDED
@@ -0,0 +1,197 @@
1
+ [redis-om](../README.md) / SemanticSearchError
2
+
3
+ # Class: SemanticSearchError
4
+
5
+ ## Hierarchy
6
+
7
+ - [`SearchError`](SearchError.md)
8
+
9
+ ↳ **`SemanticSearchError`**
10
+
11
+ ## Table of contents
12
+
13
+ ### Constructors
14
+
15
+ - [constructor](SemanticSearchError.md#constructor)
16
+
17
+ ### Properties
18
+
19
+ - [cause](SemanticSearchError.md#cause)
20
+ - [message](SemanticSearchError.md#message)
21
+ - [name](SemanticSearchError.md#name)
22
+ - [stack](SemanticSearchError.md#stack)
23
+ - [prepareStackTrace](SemanticSearchError.md#preparestacktrace)
24
+ - [stackTraceLimit](SemanticSearchError.md#stacktracelimit)
25
+
26
+ ### Methods
27
+
28
+ - [captureStackTrace](SemanticSearchError.md#capturestacktrace)
29
+
30
+ ## Constructors
31
+
32
+ ### constructor
33
+
34
+ • **new SemanticSearchError**(`message?`)
35
+
36
+ #### Parameters
37
+
38
+ | Name | Type |
39
+ | :------ | :------ |
40
+ | `message?` | `string` |
41
+
42
+ #### Inherited from
43
+
44
+ [SearchError](SearchError.md).[constructor](SearchError.md#constructor)
45
+
46
+ #### Defined in
47
+
48
+ node_modules/typescript/lib/lib.es5.d.ts:1059
49
+
50
+ • **new SemanticSearchError**(`message?`, `options?`)
51
+
52
+ #### Parameters
53
+
54
+ | Name | Type |
55
+ | :------ | :------ |
56
+ | `message?` | `string` |
57
+ | `options?` | `ErrorOptions` |
58
+
59
+ #### Inherited from
60
+
61
+ [SearchError](SearchError.md).[constructor](SearchError.md#constructor)
62
+
63
+ #### Defined in
64
+
65
+ node_modules/typescript/lib/lib.es2022.error.d.ts:30
66
+
67
+ ## Properties
68
+
69
+ ### cause
70
+
71
+ • `Optional` **cause**: `unknown`
72
+
73
+ #### Inherited from
74
+
75
+ [SearchError](SearchError.md).[cause](SearchError.md#cause)
76
+
77
+ #### Defined in
78
+
79
+ node_modules/typescript/lib/lib.es2022.error.d.ts:26
80
+
81
+ ___
82
+
83
+ ### message
84
+
85
+ • **message**: `string`
86
+
87
+ #### Inherited from
88
+
89
+ [SearchError](SearchError.md).[message](SearchError.md#message)
90
+
91
+ #### Defined in
92
+
93
+ node_modules/typescript/lib/lib.es5.d.ts:1054
94
+
95
+ ___
96
+
97
+ ### name
98
+
99
+ • **name**: `string`
100
+
101
+ #### Inherited from
102
+
103
+ [SearchError](SearchError.md).[name](SearchError.md#name)
104
+
105
+ #### Defined in
106
+
107
+ node_modules/typescript/lib/lib.es5.d.ts:1053
108
+
109
+ ___
110
+
111
+ ### stack
112
+
113
+ • `Optional` **stack**: `string`
114
+
115
+ #### Inherited from
116
+
117
+ [SearchError](SearchError.md).[stack](SearchError.md#stack)
118
+
119
+ #### Defined in
120
+
121
+ node_modules/typescript/lib/lib.es5.d.ts:1055
122
+
123
+ ___
124
+
125
+ ### prepareStackTrace
126
+
127
+ ▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
128
+
129
+ #### Type declaration
130
+
131
+ ▸ (`err`, `stackTraces`): `any`
132
+
133
+ Optional override for formatting stack traces
134
+
135
+ **`See`**
136
+
137
+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
138
+
139
+ ##### Parameters
140
+
141
+ | Name | Type |
142
+ | :------ | :------ |
143
+ | `err` | `Error` |
144
+ | `stackTraces` | `CallSite`[] |
145
+
146
+ ##### Returns
147
+
148
+ `any`
149
+
150
+ #### Inherited from
151
+
152
+ [SearchError](SearchError.md).[prepareStackTrace](SearchError.md#preparestacktrace)
153
+
154
+ #### Defined in
155
+
156
+ node_modules/@types/node/globals.d.ts:11
157
+
158
+ ___
159
+
160
+ ### stackTraceLimit
161
+
162
+ ▪ `Static` **stackTraceLimit**: `number`
163
+
164
+ #### Inherited from
165
+
166
+ [SearchError](SearchError.md).[stackTraceLimit](SearchError.md#stacktracelimit)
167
+
168
+ #### Defined in
169
+
170
+ node_modules/@types/node/globals.d.ts:13
171
+
172
+ ## Methods
173
+
174
+ ### captureStackTrace
175
+
176
+ ▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
177
+
178
+ Create .stack property on a target object
179
+
180
+ #### Parameters
181
+
182
+ | Name | Type |
183
+ | :------ | :------ |
184
+ | `targetObject` | `object` |
185
+ | `constructorOpt?` | `Function` |
186
+
187
+ #### Returns
188
+
189
+ `void`
190
+
191
+ #### Inherited from
192
+
193
+ [SearchError](SearchError.md).[captureStackTrace](SearchError.md#capturestacktrace)
194
+
195
+ #### Defined in
196
+
197
+ node_modules/@types/node/globals.d.ts:4
package/docs/classes/Where.md ADDED
@@ -0,0 +1,43 @@
1
+ [redis-om](../README.md) / Where
2
+
3
+ # Class: Where
4
+
5
+ Abstract base class used extensively with [Search](Search.md).
6
+
7
+ ## Hierarchy
8
+
9
+ - **`Where`**
10
+
11
+ ↳ [`WhereField`](WhereField.md)
12
+
13
+ ## Table of contents
14
+
15
+ ### Constructors
16
+
17
+ - [constructor](Where.md#constructor)
18
+
19
+ ### Methods
20
+
21
+ - [toString](Where.md#tostring)
22
+
23
+ ## Constructors
24
+
25
+ ### constructor
26
+
27
+ • **new Where**()
28
+
29
+ ## Methods
30
+
31
+ ### toString
32
+
33
+ ▸ `Abstract` **toString**(): `string`
34
+
35
+ Converts this [Where](Where.md) into a portion of a RediSearch query.
36
+
37
+ #### Returns
38
+
39
+ `string`
40
+
41
+ #### Defined in
42
+
43
+ [lib/search/where.ts:8](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where.ts#L8)