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/NullJsonValue.md ADDED
@@ -0,0 +1,228 @@
1
+ [redis-om](../README.md) / NullJsonValue
2
+
3
+ # Class: NullJsonValue
4
+
5
+ ## Hierarchy
6
+
7
+ - [`InvalidValue`](InvalidValue.md)
8
+
9
+ ↳ **`NullJsonValue`**
10
+
11
+ ## Table of contents
12
+
13
+ ### Constructors
14
+
15
+ - [constructor](NullJsonValue.md#constructor)
16
+
17
+ ### Properties
18
+
19
+ - [cause](NullJsonValue.md#cause)
20
+ - [message](NullJsonValue.md#message)
21
+ - [name](NullJsonValue.md#name)
22
+ - [stack](NullJsonValue.md#stack)
23
+ - [prepareStackTrace](NullJsonValue.md#preparestacktrace)
24
+ - [stackTraceLimit](NullJsonValue.md#stacktracelimit)
25
+
26
+ ### Accessors
27
+
28
+ - [fieldName](NullJsonValue.md#fieldname)
29
+ - [fieldType](NullJsonValue.md#fieldtype)
30
+ - [jsonPath](NullJsonValue.md#jsonpath)
31
+
32
+ ### Methods
33
+
34
+ - [captureStackTrace](NullJsonValue.md#capturestacktrace)
35
+
36
+ ## Constructors
37
+
38
+ ### constructor
39
+
40
+ • **new NullJsonValue**(`field`)
41
+
42
+ #### Parameters
43
+
44
+ | Name | Type |
45
+ | :------ | :------ |
46
+ | `field` | [`Field`](Field.md) |
47
+
48
+ #### Overrides
49
+
50
+ [InvalidValue](InvalidValue.md).[constructor](InvalidValue.md#constructor)
51
+
52
+ #### Defined in
53
+
54
+ [lib/error/invalid-value.ts:10](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-value.ts#L10)
55
+
56
+ ## Properties
57
+
58
+ ### cause
59
+
60
+ • `Optional` **cause**: `unknown`
61
+
62
+ #### Inherited from
63
+
64
+ [InvalidValue](InvalidValue.md).[cause](InvalidValue.md#cause)
65
+
66
+ #### Defined in
67
+
68
+ node_modules/typescript/lib/lib.es2022.error.d.ts:26
69
+
70
+ ___
71
+
72
+ ### message
73
+
74
+ • **message**: `string`
75
+
76
+ #### Inherited from
77
+
78
+ [InvalidValue](InvalidValue.md).[message](InvalidValue.md#message)
79
+
80
+ #### Defined in
81
+
82
+ node_modules/typescript/lib/lib.es5.d.ts:1054
83
+
84
+ ___
85
+
86
+ ### name
87
+
88
+ • **name**: `string`
89
+
90
+ #### Inherited from
91
+
92
+ [InvalidValue](InvalidValue.md).[name](InvalidValue.md#name)
93
+
94
+ #### Defined in
95
+
96
+ node_modules/typescript/lib/lib.es5.d.ts:1053
97
+
98
+ ___
99
+
100
+ ### stack
101
+
102
+ • `Optional` **stack**: `string`
103
+
104
+ #### Inherited from
105
+
106
+ [InvalidValue](InvalidValue.md).[stack](InvalidValue.md#stack)
107
+
108
+ #### Defined in
109
+
110
+ node_modules/typescript/lib/lib.es5.d.ts:1055
111
+
112
+ ___
113
+
114
+ ### prepareStackTrace
115
+
116
+ ▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
117
+
118
+ #### Type declaration
119
+
120
+ ▸ (`err`, `stackTraces`): `any`
121
+
122
+ Optional override for formatting stack traces
123
+
124
+ **`See`**
125
+
126
+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
127
+
128
+ ##### Parameters
129
+
130
+ | Name | Type |
131
+ | :------ | :------ |
132
+ | `err` | `Error` |
133
+ | `stackTraces` | `CallSite`[] |
134
+
135
+ ##### Returns
136
+
137
+ `any`
138
+
139
+ #### Inherited from
140
+
141
+ [InvalidValue](InvalidValue.md).[prepareStackTrace](InvalidValue.md#preparestacktrace)
142
+
143
+ #### Defined in
144
+
145
+ node_modules/@types/node/globals.d.ts:11
146
+
147
+ ___
148
+
149
+ ### stackTraceLimit
150
+
151
+ ▪ `Static` **stackTraceLimit**: `number`
152
+
153
+ #### Inherited from
154
+
155
+ [InvalidValue](InvalidValue.md).[stackTraceLimit](InvalidValue.md#stacktracelimit)
156
+
157
+ #### Defined in
158
+
159
+ node_modules/@types/node/globals.d.ts:13
160
+
161
+ ## Accessors
162
+
163
+ ### fieldName
164
+
165
+ • `get` **fieldName**(): `string`
166
+
167
+ #### Returns
168
+
169
+ `string`
170
+
171
+ #### Defined in
172
+
173
+ [lib/error/invalid-value.ts:16](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-value.ts#L16)
174
+
175
+ ___
176
+
177
+ ### fieldType
178
+
179
+ • `get` **fieldType**(): [`FieldType`](../README.md#fieldtype)
180
+
181
+ #### Returns
182
+
183
+ [`FieldType`](../README.md#fieldtype)
184
+
185
+ #### Defined in
186
+
187
+ [lib/error/invalid-value.ts:17](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-value.ts#L17)
188
+
189
+ ___
190
+
191
+ ### jsonPath
192
+
193
+ • `get` **jsonPath**(): `string`
194
+
195
+ #### Returns
196
+
197
+ `string`
198
+
199
+ #### Defined in
200
+
201
+ [lib/error/invalid-value.ts:18](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-value.ts#L18)
202
+
203
+ ## Methods
204
+
205
+ ### captureStackTrace
206
+
207
+ ▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
208
+
209
+ Create .stack property on a target object
210
+
211
+ #### Parameters
212
+
213
+ | Name | Type |
214
+ | :------ | :------ |
215
+ | `targetObject` | `object` |
216
+ | `constructorOpt?` | `Function` |
217
+
218
+ #### Returns
219
+
220
+ `void`
221
+
222
+ #### Inherited from
223
+
224
+ [InvalidValue](InvalidValue.md).[captureStackTrace](InvalidValue.md#capturestacktrace)
225
+
226
+ #### Defined in
227
+
228
+ node_modules/@types/node/globals.d.ts:4
package/docs/classes/PointOutOfRange.md ADDED
@@ -0,0 +1,203 @@
1
+ [redis-om](../README.md) / PointOutOfRange
2
+
3
+ # Class: PointOutOfRange
4
+
5
+ ## Hierarchy
6
+
7
+ - [`RedisOmError`](RedisOmError.md)
8
+
9
+ ↳ **`PointOutOfRange`**
10
+
11
+ ## Table of contents
12
+
13
+ ### Constructors
14
+
15
+ - [constructor](PointOutOfRange.md#constructor)
16
+
17
+ ### Properties
18
+
19
+ - [cause](PointOutOfRange.md#cause)
20
+ - [message](PointOutOfRange.md#message)
21
+ - [name](PointOutOfRange.md#name)
22
+ - [stack](PointOutOfRange.md#stack)
23
+ - [prepareStackTrace](PointOutOfRange.md#preparestacktrace)
24
+ - [stackTraceLimit](PointOutOfRange.md#stacktracelimit)
25
+
26
+ ### Accessors
27
+
28
+ - [point](PointOutOfRange.md#point)
29
+
30
+ ### Methods
31
+
32
+ - [captureStackTrace](PointOutOfRange.md#capturestacktrace)
33
+
34
+ ## Constructors
35
+
36
+ ### constructor
37
+
38
+ • **new PointOutOfRange**(`point`)
39
+
40
+ #### Parameters
41
+
42
+ | Name | Type |
43
+ | :------ | :------ |
44
+ | `point` | [`Point`](../README.md#point) |
45
+
46
+ #### Overrides
47
+
48
+ [RedisOmError](RedisOmError.md).[constructor](RedisOmError.md#constructor)
49
+
50
+ #### Defined in
51
+
52
+ [lib/error/point-out-of-range.ts:9](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/point-out-of-range.ts#L9)
53
+
54
+ ## Properties
55
+
56
+ ### cause
57
+
58
+ • `Optional` **cause**: `unknown`
59
+
60
+ #### Inherited from
61
+
62
+ [RedisOmError](RedisOmError.md).[cause](RedisOmError.md#cause)
63
+
64
+ #### Defined in
65
+
66
+ node_modules/typescript/lib/lib.es2022.error.d.ts:26
67
+
68
+ ___
69
+
70
+ ### message
71
+
72
+ • **message**: `string`
73
+
74
+ #### Inherited from
75
+
76
+ [RedisOmError](RedisOmError.md).[message](RedisOmError.md#message)
77
+
78
+ #### Defined in
79
+
80
+ node_modules/typescript/lib/lib.es5.d.ts:1054
81
+
82
+ ___
83
+
84
+ ### name
85
+
86
+ • **name**: `string`
87
+
88
+ #### Inherited from
89
+
90
+ [RedisOmError](RedisOmError.md).[name](RedisOmError.md#name)
91
+
92
+ #### Defined in
93
+
94
+ node_modules/typescript/lib/lib.es5.d.ts:1053
95
+
96
+ ___
97
+
98
+ ### stack
99
+
100
+ • `Optional` **stack**: `string`
101
+
102
+ #### Inherited from
103
+
104
+ [RedisOmError](RedisOmError.md).[stack](RedisOmError.md#stack)
105
+
106
+ #### Defined in
107
+
108
+ node_modules/typescript/lib/lib.es5.d.ts:1055
109
+
110
+ ___
111
+
112
+ ### prepareStackTrace
113
+
114
+ ▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
115
+
116
+ #### Type declaration
117
+
118
+ ▸ (`err`, `stackTraces`): `any`
119
+
120
+ Optional override for formatting stack traces
121
+
122
+ **`See`**
123
+
124
+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
125
+
126
+ ##### Parameters
127
+
128
+ | Name | Type |
129
+ | :------ | :------ |
130
+ | `err` | `Error` |
131
+ | `stackTraces` | `CallSite`[] |
132
+
133
+ ##### Returns
134
+
135
+ `any`
136
+
137
+ #### Inherited from
138
+
139
+ [RedisOmError](RedisOmError.md).[prepareStackTrace](RedisOmError.md#preparestacktrace)
140
+
141
+ #### Defined in
142
+
143
+ node_modules/@types/node/globals.d.ts:11
144
+
145
+ ___
146
+
147
+ ### stackTraceLimit
148
+
149
+ ▪ `Static` **stackTraceLimit**: `number`
150
+
151
+ #### Inherited from
152
+
153
+ [RedisOmError](RedisOmError.md).[stackTraceLimit](RedisOmError.md#stacktracelimit)
154
+
155
+ #### Defined in
156
+
157
+ node_modules/@types/node/globals.d.ts:13
158
+
159
+ ## Accessors
160
+
161
+ ### point
162
+
163
+ • `get` **point**(): `Object`
164
+
165
+ #### Returns
166
+
167
+ `Object`
168
+
169
+ | Name | Type |
170
+ | :------ | :------ |
171
+ | `latitude` | `number` |
172
+ | `longitude` | `number` |
173
+
174
+ #### Defined in
175
+
176
+ [lib/error/point-out-of-range.ts:15](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/point-out-of-range.ts#L15)
177
+
178
+ ## Methods
179
+
180
+ ### captureStackTrace
181
+
182
+ ▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
183
+
184
+ Create .stack property on a target object
185
+
186
+ #### Parameters
187
+
188
+ | Name | Type |
189
+ | :------ | :------ |
190
+ | `targetObject` | `object` |
191
+ | `constructorOpt?` | `Function` |
192
+
193
+ #### Returns
194
+
195
+ `void`
196
+
197
+ #### Inherited from
198
+
199
+ [RedisOmError](RedisOmError.md).[captureStackTrace](RedisOmError.md#capturestacktrace)
200
+
201
+ #### Defined in
202
+
203
+ node_modules/@types/node/globals.d.ts:4