From 3f7d08413ddc35b98db0d45895f63bfe00606d11 Mon Sep 17 00:00:00 2001 From: Guy Royse Date: Tue, 7 Mar 2023 14:44:25 -0500 Subject: [PATCH] regenerated docs --- docs/README.md | 69 +++++---- docs/classes/AbstractSearch.md | 76 +++++----- docs/classes/ArrayHashInput.md | 198 ++++++++++++++++++++++++ docs/classes/Circle.md | 34 ++--- docs/classes/Client.md | 14 +- docs/classes/Field.md | 26 ++-- docs/classes/FieldNotInSchema.md | 198 ++++++++++++++++++++++++ docs/classes/InvalidHashInput.md | 213 ++++++++++++++++++++++++++ docs/classes/InvalidHashValue.md | 228 ++++++++++++++++++++++++++++ docs/classes/InvalidInput.md | 207 +++++++++++++++++++++++++ docs/classes/InvalidJsonInput.md | 228 ++++++++++++++++++++++++++++ docs/classes/InvalidJsonValue.md | 228 ++++++++++++++++++++++++++++ docs/classes/InvalidSchema.md | 197 ++++++++++++++++++++++++ docs/classes/InvalidValue.md | 203 +++++++++++++++++++++++++ docs/classes/NestedHashInput.md | 198 ++++++++++++++++++++++++ docs/classes/NullJsonInput.md | 228 ++++++++++++++++++++++++++++ docs/classes/NullJsonValue.md | 228 ++++++++++++++++++++++++++++ docs/classes/PointOutOfRange.md | 203 +++++++++++++++++++++++++ docs/classes/RawSearch.md | 76 +++++----- docs/classes/RedisOmError.md | 10 ++ docs/classes/Repository.md | 30 ++-- docs/classes/Schema.md | 22 +-- docs/classes/Search.md | 88 +++++------ docs/classes/SearchError.md | 201 ++++++++++++++++++++++++ docs/classes/SemanticSearchError.md | 197 ++++++++++++++++++++++++ docs/classes/Where.md | 2 +- docs/classes/WhereField.md | 74 ++++----- 27 files changed, 3428 insertions(+), 248 deletions(-) create mode 100644 docs/classes/ArrayHashInput.md create mode 100644 docs/classes/FieldNotInSchema.md create mode 100644 docs/classes/InvalidHashInput.md create mode 100644 docs/classes/InvalidHashValue.md create mode 100644 docs/classes/InvalidInput.md create mode 100644 docs/classes/InvalidJsonInput.md create mode 100644 docs/classes/InvalidJsonValue.md create mode 100644 docs/classes/InvalidSchema.md create mode 100644 docs/classes/InvalidValue.md create mode 100644 docs/classes/NestedHashInput.md create mode 100644 docs/classes/NullJsonInput.md create mode 100644 docs/classes/NullJsonValue.md create mode 100644 docs/classes/PointOutOfRange.md create mode 100644 docs/classes/SearchError.md create mode 100644 docs/classes/SemanticSearchError.md diff --git a/docs/README.md b/docs/README.md index 7dd96ccb..459f4165 100644 --- a/docs/README.md +++ b/docs/README.md @@ -7,14 +7,29 @@ redis-om ### Classes - [AbstractSearch](classes/AbstractSearch.md) +- [ArrayHashInput](classes/ArrayHashInput.md) - [Circle](classes/Circle.md) - [Client](classes/Client.md) - [Field](classes/Field.md) +- [FieldNotInSchema](classes/FieldNotInSchema.md) +- [InvalidHashInput](classes/InvalidHashInput.md) +- [InvalidHashValue](classes/InvalidHashValue.md) +- [InvalidInput](classes/InvalidInput.md) +- [InvalidJsonInput](classes/InvalidJsonInput.md) +- [InvalidJsonValue](classes/InvalidJsonValue.md) +- [InvalidSchema](classes/InvalidSchema.md) +- [InvalidValue](classes/InvalidValue.md) +- [NestedHashInput](classes/NestedHashInput.md) +- [NullJsonInput](classes/NullJsonInput.md) +- [NullJsonValue](classes/NullJsonValue.md) +- [PointOutOfRange](classes/PointOutOfRange.md) - [RawSearch](classes/RawSearch.md) - [RedisOmError](classes/RedisOmError.md) - [Repository](classes/Repository.md) - [Schema](classes/Schema.md) - [Search](classes/Search.md) +- [SearchError](classes/SearchError.md) +- [SemanticSearchError](classes/SemanticSearchError.md) - [Where](classes/Where.md) - [WhereField](classes/WhereField.md) @@ -78,7 +93,7 @@ All configuration properties that any field might have, regardless of type. #### Defined in -[lib/schema/definitions.ts:5](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/definitions.ts#L5) +[lib/schema/definitions.ts:5](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/definitions.ts#L5) ___ @@ -90,7 +105,7 @@ A field representing a boolean. #### Defined in -[lib/schema/definitions.ts:78](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/definitions.ts#L78) +[lib/schema/definitions.ts:78](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/definitions.ts#L78) ___ @@ -116,7 +131,7 @@ A function that defines a circle for `.inCircle` searches. #### Defined in -[lib/search/where-point.ts:8](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-point.ts#L8) +[lib/search/where-point.ts:8](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-point.ts#L8) ___ @@ -128,7 +143,7 @@ The configuration properties that all fields have in common. #### Defined in -[lib/schema/definitions.ts:75](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/definitions.ts#L75) +[lib/schema/definitions.ts:75](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/definitions.ts#L75) ___ @@ -140,7 +155,7 @@ The type of data structure in Redis to map objects to. #### Defined in -[lib/schema/options.ts:2](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/options.ts#L2) +[lib/schema/options.ts:2](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/options.ts#L2) ___ @@ -152,7 +167,7 @@ A field representing a date/time. #### Defined in -[lib/schema/definitions.ts:83](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/definitions.ts#L83) +[lib/schema/definitions.ts:83](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/definitions.ts#L83) ___ @@ -164,7 +179,7 @@ Defines the objects returned from calls to [repositories](classes/Repository.md) #### Defined in -[lib/entity/entity.ts:8](https://github.com/redis/redis-om-node/blob/e552415/lib/entity/entity.ts#L8) +[lib/entity/entity.ts:8](https://github.com/redis/redis-om-node/blob/5777b6c/lib/entity/entity.ts#L8) ___ @@ -180,7 +195,7 @@ The free-form data associated with an [Entity](README.md#entity). #### Defined in -[lib/entity/entity.ts:18](https://github.com/redis/redis-om-node/blob/e552415/lib/entity/entity.ts#L18) +[lib/entity/entity.ts:18](https://github.com/redis/redis-om-node/blob/5777b6c/lib/entity/entity.ts#L18) ___ @@ -192,7 +207,7 @@ Valid types for values in an [Entity](README.md#entity). #### Defined in -[lib/entity/entity.ts:23](https://github.com/redis/redis-om-node/blob/e552415/lib/entity/entity.ts#L23) +[lib/entity/entity.ts:23](https://github.com/redis/redis-om-node/blob/5777b6c/lib/entity/entity.ts#L23) ___ @@ -204,7 +219,7 @@ Contains instructions telling how to map a property on an [Entity](README.md#ent #### Defined in -[lib/schema/definitions.ts:112](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/definitions.ts#L112) +[lib/schema/definitions.ts:112](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/definitions.ts#L112) ___ @@ -216,7 +231,7 @@ Valid field types for a [FieldDefinition](README.md#fielddefinition). #### Defined in -[lib/schema/definitions.ts:2](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/definitions.ts#L2) +[lib/schema/definitions.ts:2](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/definitions.ts#L2) ___ @@ -236,7 +251,7 @@ A function that generates random entityIds. #### Defined in -[lib/schema/options.ts:5](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/options.ts#L5) +[lib/schema/options.ts:5](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/options.ts#L5) ___ @@ -248,7 +263,7 @@ A field representing a number. #### Defined in -[lib/schema/definitions.ts:88](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/definitions.ts#L88) +[lib/schema/definitions.ts:88](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/definitions.ts#L88) ___ @@ -267,7 +282,7 @@ Defines a point on the globe using longitude and latitude. #### Defined in -[lib/entity/entity.ts:26](https://github.com/redis/redis-om-node/blob/e552415/lib/entity/entity.ts#L26) +[lib/entity/entity.ts:26](https://github.com/redis/redis-om-node/blob/5777b6c/lib/entity/entity.ts#L26) ___ @@ -279,7 +294,7 @@ A field representing a point on the globe. #### Defined in -[lib/schema/definitions.ts:93](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/definitions.ts#L93) +[lib/schema/definitions.ts:93](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/definitions.ts#L93) ___ @@ -291,7 +306,7 @@ A conventional Redis connection. #### Defined in -[lib/client/client.ts:8](https://github.com/redis/redis-om-node/blob/e552415/lib/client/client.ts#L8) +[lib/client/client.ts:8](https://github.com/redis/redis-om-node/blob/5777b6c/lib/client/client.ts#L8) ___ @@ -303,7 +318,7 @@ A clustered Redis connection. #### Defined in -[lib/client/client.ts:11](https://github.com/redis/redis-om-node/blob/e552415/lib/client/client.ts#L11) +[lib/client/client.ts:11](https://github.com/redis/redis-om-node/blob/5777b6c/lib/client/client.ts#L11) ___ @@ -315,7 +330,7 @@ A Redis connection, clustered or conventional. #### Defined in -[lib/client/client.ts:14](https://github.com/redis/redis-om-node/blob/e552415/lib/client/client.ts#L14) +[lib/client/client.ts:14](https://github.com/redis/redis-om-node/blob/5777b6c/lib/client/client.ts#L14) ___ @@ -327,7 +342,7 @@ Group of [FieldDefinition](README.md#fielddefinition)s that define the schema fo #### Defined in -[lib/schema/definitions.ts:118](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/definitions.ts#L118) +[lib/schema/definitions.ts:118](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/definitions.ts#L118) ___ @@ -350,7 +365,7 @@ Configuration options for a [Schema](classes/Schema.md). #### Defined in -[lib/schema/options.ts:11](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/options.ts#L11) +[lib/schema/options.ts:11](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/options.ts#L11) ___ @@ -362,7 +377,7 @@ Valid values for how to use stop words for a given [Schema](classes/Schema.md). #### Defined in -[lib/schema/options.ts:8](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/options.ts#L8) +[lib/schema/options.ts:8](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/options.ts#L8) ___ @@ -374,7 +389,7 @@ A field representing an array of strings. #### Defined in -[lib/schema/definitions.ts:97](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/definitions.ts#L97) +[lib/schema/definitions.ts:97](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/definitions.ts#L97) ___ @@ -386,7 +401,7 @@ A field representing a whole string. #### Defined in -[lib/schema/definitions.ts:102](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/definitions.ts#L102) +[lib/schema/definitions.ts:102](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/definitions.ts#L102) ___ @@ -412,7 +427,7 @@ A function that takes a [Search](classes/Search.md) and returns a [Search](class #### Defined in -[lib/search/search.ts:26](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L26) +[lib/search/search.ts:26](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L26) ___ @@ -424,7 +439,7 @@ A field representing searchable text. #### Defined in -[lib/schema/definitions.ts:107](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/definitions.ts#L107) +[lib/schema/definitions.ts:107](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/definitions.ts#L107) ## Variables @@ -436,7 +451,7 @@ The Symbol used to access the entity ID of an [Entity](README.md#entity). #### Defined in -[lib/entity/entity.ts:2](https://github.com/redis/redis-om-node/blob/e552415/lib/entity/entity.ts#L2) +[lib/entity/entity.ts:2](https://github.com/redis/redis-om-node/blob/5777b6c/lib/entity/entity.ts#L2) ___ @@ -448,4 +463,4 @@ The Symbol used to access the keyname of an [Entity](README.md#entity). #### Defined in -[lib/entity/entity.ts:5](https://github.com/redis/redis-om-node/blob/e552415/lib/entity/entity.ts#L5) +[lib/entity/entity.ts:5](https://github.com/redis/redis-om-node/blob/5777b6c/lib/entity/entity.ts#L5) diff --git a/docs/classes/AbstractSearch.md b/docs/classes/AbstractSearch.md index c0cd2096..fb3309f5 100644 --- a/docs/classes/AbstractSearch.md +++ b/docs/classes/AbstractSearch.md @@ -79,7 +79,7 @@ this #### Defined in -[lib/search/search.ts:308](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L308) +[lib/search/search.ts:308](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L308) ## Methods @@ -111,7 +111,7 @@ An array of [Entities](../README.md#entity) matching the query. #### Defined in -[lib/search/search.ts:264](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L264) +[lib/search/search.ts:264](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L264) ___ @@ -143,7 +143,7 @@ An array of entity IDs matching the query. #### Defined in -[lib/search/search.ts:282](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L282) +[lib/search/search.ts:282](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L282) ___ @@ -175,7 +175,7 @@ An array of key names matching the query. #### Defined in -[lib/search/search.ts:300](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L300) +[lib/search/search.ts:300](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L300) ___ @@ -191,7 +191,7 @@ Returns the number of [Entities](../README.md#entity) that match this query. #### Defined in -[lib/search/search.ts:188](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L188) +[lib/search/search.ts:188](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L188) ___ @@ -207,7 +207,7 @@ Returns the first [Entity](../README.md#entity) that matches this query. #### Defined in -[lib/search/search.ts:229](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L229) +[lib/search/search.ts:229](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L229) ___ @@ -223,7 +223,7 @@ Returns the first entity ID that matches this query. #### Defined in -[lib/search/search.ts:237](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L237) +[lib/search/search.ts:237](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L237) ___ @@ -239,7 +239,7 @@ Returns the first key name that matches this query. #### Defined in -[lib/search/search.ts:245](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L245) +[lib/search/search.ts:245](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L245) ___ @@ -263,7 +263,7 @@ The entity ID [Entity](../README.md#entity) with the maximal value #### Defined in -[lib/search/search.ts:162](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L162) +[lib/search/search.ts:162](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L162) ___ @@ -287,7 +287,7 @@ The entity ID with the maximal value #### Defined in -[lib/search/search.ts:171](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L171) +[lib/search/search.ts:171](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L171) ___ @@ -311,7 +311,7 @@ The key name with the maximal value #### Defined in -[lib/search/search.ts:180](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L180) +[lib/search/search.ts:180](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L180) ___ @@ -335,7 +335,7 @@ The [Entity](../README.md#entity) with the minimal value #### Defined in -[lib/search/search.ts:135](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L135) +[lib/search/search.ts:135](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L135) ___ @@ -359,7 +359,7 @@ The entity ID with the minimal value #### Defined in -[lib/search/search.ts:144](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L144) +[lib/search/search.ts:144](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L144) ___ @@ -383,7 +383,7 @@ The key name with the minimal value #### Defined in -[lib/search/search.ts:153](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L153) +[lib/search/search.ts:153](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L153) ___ @@ -408,7 +408,7 @@ An array of [Entities](../README.md#entity) matching the query. #### Defined in -[lib/search/search.ts:199](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L199) +[lib/search/search.ts:199](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L199) ___ @@ -433,7 +433,7 @@ An array of strings matching the query. #### Defined in -[lib/search/search.ts:210](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L210) +[lib/search/search.ts:210](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L210) ___ @@ -458,7 +458,7 @@ An array of strings matching the query. #### Defined in -[lib/search/search.ts:221](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L221) +[lib/search/search.ts:221](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L221) ___ @@ -481,7 +481,7 @@ Alias for [all](Search.md#all). #### Defined in -[lib/search/search.ts:406](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L406) +[lib/search/search.ts:406](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L406) ___ @@ -504,7 +504,7 @@ Alias for [allIds](Search.md#allids). #### Defined in -[lib/search/search.ts:413](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L413) +[lib/search/search.ts:413](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L413) ___ @@ -527,7 +527,7 @@ Alias for [allKeys](Search.md#allkeys). #### Defined in -[lib/search/search.ts:420](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L420) +[lib/search/search.ts:420](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L420) ___ @@ -543,7 +543,7 @@ Alias for [count](Search.md#count). #### Defined in -[lib/search/search.ts:357](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L357) +[lib/search/search.ts:357](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L357) ___ @@ -559,7 +559,7 @@ Alias for [first](Search.md#first). #### Defined in -[lib/search/search.ts:385](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L385) +[lib/search/search.ts:385](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L385) ___ @@ -575,7 +575,7 @@ Alias for [firstId](Search.md#firstid). #### Defined in -[lib/search/search.ts:392](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L392) +[lib/search/search.ts:392](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L392) ___ @@ -591,7 +591,7 @@ Alias for [firstKey](Search.md#firstkey). #### Defined in -[lib/search/search.ts:399](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L399) +[lib/search/search.ts:399](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L399) ___ @@ -613,7 +613,7 @@ Alias for [max](Search.md#max). #### Defined in -[lib/search/search.ts:336](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L336) +[lib/search/search.ts:336](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L336) ___ @@ -635,7 +635,7 @@ Alias for [maxId](Search.md#maxid). #### Defined in -[lib/search/search.ts:343](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L343) +[lib/search/search.ts:343](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L343) ___ @@ -657,7 +657,7 @@ Alias for [maxKey](Search.md#maxkey). #### Defined in -[lib/search/search.ts:350](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L350) +[lib/search/search.ts:350](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L350) ___ @@ -679,7 +679,7 @@ Alias for [min](Search.md#min). #### Defined in -[lib/search/search.ts:315](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L315) +[lib/search/search.ts:315](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L315) ___ @@ -701,7 +701,7 @@ Alias for [minId](Search.md#minid). #### Defined in -[lib/search/search.ts:322](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L322) +[lib/search/search.ts:322](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L322) ___ @@ -723,7 +723,7 @@ Alias for [minKey](Search.md#minkey). #### Defined in -[lib/search/search.ts:329](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L329) +[lib/search/search.ts:329](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L329) ___ @@ -746,7 +746,7 @@ Alias for [page](Search.md#page). #### Defined in -[lib/search/search.ts:364](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L364) +[lib/search/search.ts:364](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L364) ___ @@ -769,7 +769,7 @@ Alias for [pageOfIds](Search.md#pageofids). #### Defined in -[lib/search/search.ts:371](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L371) +[lib/search/search.ts:371](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L371) ___ @@ -792,7 +792,7 @@ Alias for [pageOfKeys](Search.md#pageofkeys). #### Defined in -[lib/search/search.ts:378](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L378) +[lib/search/search.ts:378](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L378) ___ @@ -814,7 +814,7 @@ Alias for [sortAscending](Search.md#sortascending). #### Defined in -[lib/search/search.ts:86](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L86) +[lib/search/search.ts:86](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L86) ___ @@ -838,7 +838,7 @@ this #### Defined in -[lib/search/search.ts:63](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L63) +[lib/search/search.ts:63](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L63) ___ @@ -863,7 +863,7 @@ this #### Defined in -[lib/search/search.ts:96](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L96) +[lib/search/search.ts:96](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L96) ___ @@ -885,7 +885,7 @@ Alias for [sortDescending](Search.md#sortdescending). #### Defined in -[lib/search/search.ts:70](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L70) +[lib/search/search.ts:70](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L70) ___ @@ -909,4 +909,4 @@ this #### Defined in -[lib/search/search.ts:79](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L79) +[lib/search/search.ts:79](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L79) diff --git a/docs/classes/ArrayHashInput.md b/docs/classes/ArrayHashInput.md new file mode 100644 index 00000000..ddf3057b --- /dev/null +++ b/docs/classes/ArrayHashInput.md @@ -0,0 +1,198 @@ +[redis-om](../README.md) / ArrayHashInput + +# Class: ArrayHashInput + +## Hierarchy + +- [`InvalidInput`](InvalidInput.md) + + ↳ **`ArrayHashInput`** + +## Table of contents + +### Constructors + +- [constructor](ArrayHashInput.md#constructor) + +### Properties + +- [cause](ArrayHashInput.md#cause) +- [message](ArrayHashInput.md#message) +- [name](ArrayHashInput.md#name) +- [stack](ArrayHashInput.md#stack) +- [prepareStackTrace](ArrayHashInput.md#preparestacktrace) +- [stackTraceLimit](ArrayHashInput.md#stacktracelimit) + +### Accessors + +- [field](ArrayHashInput.md#field) + +### Methods + +- [captureStackTrace](ArrayHashInput.md#capturestacktrace) + +## Constructors + +### constructor + +• **new ArrayHashInput**(`property`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `property` | `string` | + +#### Overrides + +[InvalidInput](InvalidInput.md).[constructor](InvalidInput.md#constructor) + +#### Defined in + +[lib/error/invalid-input.ts:67](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-input.ts#L67) + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[cause](InvalidInput.md#cause) + +#### Defined in + +node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[message](InvalidInput.md#message) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[name](InvalidInput.md#name) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[stack](InvalidInput.md#stack) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[prepareStackTrace](InvalidInput.md#preparestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[stackTraceLimit](InvalidInput.md#stacktracelimit) + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Accessors + +### field + +• `get` **field**(): `string` + +#### Returns + +`string` + +#### Defined in + +[lib/error/invalid-input.ts:73](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-input.ts#L73) + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[captureStackTrace](InvalidInput.md#capturestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/classes/Circle.md b/docs/classes/Circle.md index 47ac1fbc..cfb265dc 100644 --- a/docs/classes/Circle.md +++ b/docs/classes/Circle.md @@ -54,7 +54,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:149](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-point.ts#L149) +[lib/search/where-point.ts:149](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-point.ts#L149) ___ @@ -72,7 +72,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:143](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-point.ts#L143) +[lib/search/where-point.ts:143](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-point.ts#L143) ___ @@ -90,7 +90,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:137](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-point.ts#L137) +[lib/search/where-point.ts:137](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-point.ts#L137) ___ @@ -108,7 +108,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:122](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-point.ts#L122) +[lib/search/where-point.ts:122](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-point.ts#L122) ___ @@ -126,7 +126,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:128](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-point.ts#L128) +[lib/search/where-point.ts:128](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-point.ts#L128) ___ @@ -144,7 +144,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:116](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-point.ts#L116) +[lib/search/where-point.ts:116](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-point.ts#L116) ___ @@ -162,7 +162,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:95](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-point.ts#L95) +[lib/search/where-point.ts:95](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-point.ts#L95) ___ @@ -180,7 +180,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:101](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-point.ts#L101) +[lib/search/where-point.ts:101](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-point.ts#L101) ___ @@ -198,7 +198,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:107](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-point.ts#L107) +[lib/search/where-point.ts:107](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-point.ts#L107) ___ @@ -216,7 +216,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:158](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-point.ts#L158) +[lib/search/where-point.ts:158](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-point.ts#L158) ___ @@ -234,7 +234,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:164](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-point.ts#L164) +[lib/search/where-point.ts:164](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-point.ts#L164) ___ @@ -252,7 +252,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:170](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-point.ts#L170) +[lib/search/where-point.ts:170](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-point.ts#L170) ## Methods @@ -276,7 +276,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:42](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-point.ts#L42) +[lib/search/where-point.ts:42](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-point.ts#L42) ___ @@ -300,7 +300,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:31](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-point.ts#L31) +[lib/search/where-point.ts:31](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-point.ts#L31) ___ @@ -325,7 +325,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:54](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-point.ts#L54) +[lib/search/where-point.ts:54](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-point.ts#L54) ▸ **origin**(`longitude`, `latitude`): [`Circle`](Circle.md) @@ -347,7 +347,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:64](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-point.ts#L64) +[lib/search/where-point.ts:64](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-point.ts#L64) ___ @@ -372,4 +372,4 @@ This instance. #### Defined in -[lib/search/where-point.ts:86](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-point.ts#L86) +[lib/search/where-point.ts:86](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-point.ts#L86) diff --git a/docs/classes/Client.md b/docs/classes/Client.md index 82e190ca..20b5995b 100644 --- a/docs/classes/Client.md +++ b/docs/classes/Client.md @@ -57,7 +57,7 @@ Returns the underlying Node Redis connection being used. #### Defined in -[lib/client/client.ts:70](https://github.com/redis/redis-om-node/blob/e552415/lib/client/client.ts#L70) +[lib/client/client.ts:70](https://github.com/redis/redis-om-node/blob/5777b6c/lib/client/client.ts#L70) ## Methods @@ -73,7 +73,7 @@ Close the connection to Redis. #### Defined in -[lib/client/client.ts:127](https://github.com/redis/redis-om-node/blob/e552415/lib/client/client.ts#L127) +[lib/client/client.ts:127](https://github.com/redis/redis-om-node/blob/5777b6c/lib/client/client.ts#L127) ___ @@ -97,7 +97,7 @@ A repository for the provided schema. #### Defined in -[lib/client/client.ts:119](https://github.com/redis/redis-om-node/blob/e552415/lib/client/client.ts#L119) +[lib/client/client.ts:119](https://github.com/redis/redis-om-node/blob/5777b6c/lib/client/client.ts#L119) ___ @@ -113,7 +113,7 @@ Whether a connection is already open. #### Defined in -[lib/client/client.ts:207](https://github.com/redis/redis-om-node/blob/e552415/lib/client/client.ts#L207) +[lib/client/client.ts:207](https://github.com/redis/redis-om-node/blob/5777b6c/lib/client/client.ts#L207) ___ @@ -137,7 +137,7 @@ This [Client](Client.md) instance. #### Defined in -[lib/client/client.ts:104](https://github.com/redis/redis-om-node/blob/e552415/lib/client/client.ts#L104) +[lib/client/client.ts:104](https://github.com/redis/redis-om-node/blob/5777b6c/lib/client/client.ts#L104) ___ @@ -162,7 +162,7 @@ This [Client](Client.md) instance. #### Defined in -[lib/client/client.ts:81](https://github.com/redis/redis-om-node/blob/e552415/lib/client/client.ts#L81) +[lib/client/client.ts:81](https://github.com/redis/redis-om-node/blob/5777b6c/lib/client/client.ts#L81) ___ @@ -187,4 +187,4 @@ This [Client](Client.md) instance. #### Defined in -[lib/client/client.ts:93](https://github.com/redis/redis-om-node/blob/e552415/lib/client/client.ts#L93) +[lib/client/client.ts:93](https://github.com/redis/redis-om-node/blob/5777b6c/lib/client/client.ts#L93) diff --git a/docs/classes/Field.md b/docs/classes/Field.md index 37a4168d..ff9b0789 100644 --- a/docs/classes/Field.md +++ b/docs/classes/Field.md @@ -42,7 +42,7 @@ Creates a Field. #### Defined in -[lib/schema/field.ts:17](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/field.ts#L17) +[lib/schema/field.ts:17](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/field.ts#L17) ## Accessors @@ -58,7 +58,7 @@ The case-sensitivity of the field. #### Defined in -[lib/schema/field.ts:55](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/field.ts#L55) +[lib/schema/field.ts:55](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/field.ts#L55) ___ @@ -74,7 +74,7 @@ The field name used to store this [Field](Field.md) in a Hash. #### Defined in -[lib/schema/field.ts:33](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/field.ts#L33) +[lib/schema/field.ts:33](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/field.ts#L33) ___ @@ -90,7 +90,7 @@ Indicates the field as being indexed—and thus queryable—by RediSearch. #### Defined in -[lib/schema/field.ts:60](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/field.ts#L60) +[lib/schema/field.ts:60](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/field.ts#L60) ___ @@ -106,7 +106,7 @@ The JSONPath used to store this [Field](Field.md) in a JSON document. #### Defined in -[lib/schema/field.ts:38](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/field.ts#L38) +[lib/schema/field.ts:38](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/field.ts#L38) ___ @@ -122,7 +122,7 @@ The phonetic matcher for the field. #### Defined in -[lib/schema/field.ts:80](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/field.ts#L80) +[lib/schema/field.ts:80](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/field.ts#L80) ___ @@ -138,7 +138,7 @@ The name of the field. #### Defined in -[lib/schema/field.ts:23](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/field.ts#L23) +[lib/schema/field.ts:23](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/field.ts#L23) ___ @@ -154,7 +154,7 @@ Indicates that the field is normalized. Ignored if sortable is false. #### Defined in -[lib/schema/field.ts:70](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/field.ts#L70) +[lib/schema/field.ts:70](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/field.ts#L70) ___ @@ -170,7 +170,7 @@ The separator for string[] fields when stored in Hashes. #### Defined in -[lib/schema/field.ts:45](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/field.ts#L45) +[lib/schema/field.ts:45](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/field.ts#L45) ___ @@ -186,7 +186,7 @@ Indicates that the field as sortable. #### Defined in -[lib/schema/field.ts:50](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/field.ts#L50) +[lib/schema/field.ts:50](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/field.ts#L50) ___ @@ -202,7 +202,7 @@ Indicates that the field as indexed with stemming support. #### Defined in -[lib/schema/field.ts:65](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/field.ts#L65) +[lib/schema/field.ts:65](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/field.ts#L65) ___ @@ -218,7 +218,7 @@ The [type](../README.md#fieldtype) of the field. #### Defined in -[lib/schema/field.ts:28](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/field.ts#L28) +[lib/schema/field.ts:28](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/field.ts#L28) ___ @@ -234,4 +234,4 @@ The search weight of the field. #### Defined in -[lib/schema/field.ts:75](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/field.ts#L75) +[lib/schema/field.ts:75](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/field.ts#L75) diff --git a/docs/classes/FieldNotInSchema.md b/docs/classes/FieldNotInSchema.md new file mode 100644 index 00000000..1e6780b6 --- /dev/null +++ b/docs/classes/FieldNotInSchema.md @@ -0,0 +1,198 @@ +[redis-om](../README.md) / FieldNotInSchema + +# Class: FieldNotInSchema + +## Hierarchy + +- [`SearchError`](SearchError.md) + + ↳ **`FieldNotInSchema`** + +## Table of contents + +### Constructors + +- [constructor](FieldNotInSchema.md#constructor) + +### Properties + +- [cause](FieldNotInSchema.md#cause) +- [message](FieldNotInSchema.md#message) +- [name](FieldNotInSchema.md#name) +- [stack](FieldNotInSchema.md#stack) +- [prepareStackTrace](FieldNotInSchema.md#preparestacktrace) +- [stackTraceLimit](FieldNotInSchema.md#stacktracelimit) + +### Accessors + +- [field](FieldNotInSchema.md#field) + +### Methods + +- [captureStackTrace](FieldNotInSchema.md#capturestacktrace) + +## Constructors + +### constructor + +• **new FieldNotInSchema**(`fieldName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fieldName` | `string` | + +#### Overrides + +[SearchError](SearchError.md).[constructor](SearchError.md#constructor) + +#### Defined in + +[lib/error/search-error.ts:11](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/search-error.ts#L11) + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[SearchError](SearchError.md).[cause](SearchError.md#cause) + +#### Defined in + +node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[SearchError](SearchError.md).[message](SearchError.md#message) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +[SearchError](SearchError.md).[name](SearchError.md#name) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[SearchError](SearchError.md).[stack](SearchError.md#stack) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +[SearchError](SearchError.md).[prepareStackTrace](SearchError.md#preparestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[SearchError](SearchError.md).[stackTraceLimit](SearchError.md#stacktracelimit) + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Accessors + +### field + +• `get` **field**(): `string` + +#### Returns + +`string` + +#### Defined in + +[lib/error/search-error.ts:16](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/search-error.ts#L16) + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +[SearchError](SearchError.md).[captureStackTrace](SearchError.md#capturestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/classes/InvalidHashInput.md b/docs/classes/InvalidHashInput.md new file mode 100644 index 00000000..e0b6c2ad --- /dev/null +++ b/docs/classes/InvalidHashInput.md @@ -0,0 +1,213 @@ +[redis-om](../README.md) / InvalidHashInput + +# Class: InvalidHashInput + +## Hierarchy + +- [`InvalidInput`](InvalidInput.md) + + ↳ **`InvalidHashInput`** + +## Table of contents + +### Constructors + +- [constructor](InvalidHashInput.md#constructor) + +### Properties + +- [cause](InvalidHashInput.md#cause) +- [message](InvalidHashInput.md#message) +- [name](InvalidHashInput.md#name) +- [stack](InvalidHashInput.md#stack) +- [prepareStackTrace](InvalidHashInput.md#preparestacktrace) +- [stackTraceLimit](InvalidHashInput.md#stacktracelimit) + +### Accessors + +- [fieldName](InvalidHashInput.md#fieldname) +- [fieldType](InvalidHashInput.md#fieldtype) + +### Methods + +- [captureStackTrace](InvalidHashInput.md#capturestacktrace) + +## Constructors + +### constructor + +• **new InvalidHashInput**(`field`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `field` | [`Field`](Field.md) | + +#### Overrides + +[InvalidInput](InvalidInput.md).[constructor](InvalidInput.md#constructor) + +#### Defined in + +[lib/error/invalid-input.ts:40](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-input.ts#L40) + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[cause](InvalidInput.md#cause) + +#### Defined in + +node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[message](InvalidInput.md#message) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[name](InvalidInput.md#name) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[stack](InvalidInput.md#stack) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[prepareStackTrace](InvalidInput.md#preparestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[stackTraceLimit](InvalidInput.md#stacktracelimit) + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Accessors + +### fieldName + +• `get` **fieldName**(): `string` + +#### Returns + +`string` + +#### Defined in + +[lib/error/invalid-input.ts:46](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-input.ts#L46) + +___ + +### fieldType + +• `get` **fieldType**(): [`FieldType`](../README.md#fieldtype) + +#### Returns + +[`FieldType`](../README.md#fieldtype) + +#### Defined in + +[lib/error/invalid-input.ts:47](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-input.ts#L47) + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[captureStackTrace](InvalidInput.md#capturestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/classes/InvalidHashValue.md b/docs/classes/InvalidHashValue.md new file mode 100644 index 00000000..d66518c7 --- /dev/null +++ b/docs/classes/InvalidHashValue.md @@ -0,0 +1,228 @@ +[redis-om](../README.md) / InvalidHashValue + +# Class: InvalidHashValue + +## Hierarchy + +- [`InvalidValue`](InvalidValue.md) + + ↳ **`InvalidHashValue`** + +## Table of contents + +### Constructors + +- [constructor](InvalidHashValue.md#constructor) + +### Properties + +- [cause](InvalidHashValue.md#cause) +- [message](InvalidHashValue.md#message) +- [name](InvalidHashValue.md#name) +- [stack](InvalidHashValue.md#stack) +- [prepareStackTrace](InvalidHashValue.md#preparestacktrace) +- [stackTraceLimit](InvalidHashValue.md#stacktracelimit) + +### Accessors + +- [fieldName](InvalidHashValue.md#fieldname) +- [fieldType](InvalidHashValue.md#fieldtype) +- [hashField](InvalidHashValue.md#hashfield) + +### Methods + +- [captureStackTrace](InvalidHashValue.md#capturestacktrace) + +## Constructors + +### constructor + +• **new InvalidHashValue**(`field`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `field` | [`Field`](Field.md) | + +#### Overrides + +[InvalidValue](InvalidValue.md).[constructor](InvalidValue.md#constructor) + +#### Defined in + +[lib/error/invalid-value.ts:40](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-value.ts#L40) + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[InvalidValue](InvalidValue.md).[cause](InvalidValue.md#cause) + +#### Defined in + +node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[InvalidValue](InvalidValue.md).[message](InvalidValue.md#message) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +[InvalidValue](InvalidValue.md).[name](InvalidValue.md#name) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[InvalidValue](InvalidValue.md).[stack](InvalidValue.md#stack) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +[InvalidValue](InvalidValue.md).[prepareStackTrace](InvalidValue.md#preparestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[InvalidValue](InvalidValue.md).[stackTraceLimit](InvalidValue.md#stacktracelimit) + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Accessors + +### fieldName + +• `get` **fieldName**(): `string` + +#### Returns + +`string` + +#### Defined in + +[lib/error/invalid-value.ts:46](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-value.ts#L46) + +___ + +### fieldType + +• `get` **fieldType**(): [`FieldType`](../README.md#fieldtype) + +#### Returns + +[`FieldType`](../README.md#fieldtype) + +#### Defined in + +[lib/error/invalid-value.ts:47](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-value.ts#L47) + +___ + +### hashField + +• `get` **hashField**(): `string` + +#### Returns + +`string` + +#### Defined in + +[lib/error/invalid-value.ts:48](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-value.ts#L48) + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +[InvalidValue](InvalidValue.md).[captureStackTrace](InvalidValue.md#capturestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/classes/InvalidInput.md b/docs/classes/InvalidInput.md new file mode 100644 index 00000000..9e96d3b2 --- /dev/null +++ b/docs/classes/InvalidInput.md @@ -0,0 +1,207 @@ +[redis-om](../README.md) / InvalidInput + +# Class: InvalidInput + +## Hierarchy + +- [`RedisOmError`](RedisOmError.md) + + ↳ **`InvalidInput`** + + ↳↳ [`NullJsonInput`](NullJsonInput.md) + + ↳↳ [`InvalidJsonInput`](InvalidJsonInput.md) + + ↳↳ [`InvalidHashInput`](InvalidHashInput.md) + + ↳↳ [`NestedHashInput`](NestedHashInput.md) + + ↳↳ [`ArrayHashInput`](ArrayHashInput.md) + +## Table of contents + +### Constructors + +- [constructor](InvalidInput.md#constructor) + +### Properties + +- [cause](InvalidInput.md#cause) +- [message](InvalidInput.md#message) +- [name](InvalidInput.md#name) +- [stack](InvalidInput.md#stack) +- [prepareStackTrace](InvalidInput.md#preparestacktrace) +- [stackTraceLimit](InvalidInput.md#stacktracelimit) + +### Methods + +- [captureStackTrace](InvalidInput.md#capturestacktrace) + +## Constructors + +### constructor + +• **new InvalidInput**(`message?`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Inherited from + +[RedisOmError](RedisOmError.md).[constructor](RedisOmError.md#constructor) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1059 + +• **new InvalidInput**(`message?`, `options?`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | +| `options?` | `ErrorOptions` | + +#### Inherited from + +[RedisOmError](RedisOmError.md).[constructor](RedisOmError.md#constructor) + +#### Defined in + +node_modules/typescript/lib/lib.es2022.error.d.ts:30 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[cause](RedisOmError.md#cause) + +#### Defined in + +node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[message](RedisOmError.md#message) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[name](RedisOmError.md#name) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[stack](RedisOmError.md#stack) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[prepareStackTrace](RedisOmError.md#preparestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[stackTraceLimit](RedisOmError.md#stacktracelimit) + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[captureStackTrace](RedisOmError.md#capturestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/classes/InvalidJsonInput.md b/docs/classes/InvalidJsonInput.md new file mode 100644 index 00000000..6d8b0027 --- /dev/null +++ b/docs/classes/InvalidJsonInput.md @@ -0,0 +1,228 @@ +[redis-om](../README.md) / InvalidJsonInput + +# Class: InvalidJsonInput + +## Hierarchy + +- [`InvalidInput`](InvalidInput.md) + + ↳ **`InvalidJsonInput`** + +## Table of contents + +### Constructors + +- [constructor](InvalidJsonInput.md#constructor) + +### Properties + +- [cause](InvalidJsonInput.md#cause) +- [message](InvalidJsonInput.md#message) +- [name](InvalidJsonInput.md#name) +- [stack](InvalidJsonInput.md#stack) +- [prepareStackTrace](InvalidJsonInput.md#preparestacktrace) +- [stackTraceLimit](InvalidJsonInput.md#stacktracelimit) + +### Accessors + +- [fieldName](InvalidJsonInput.md#fieldname) +- [fieldType](InvalidJsonInput.md#fieldtype) +- [jsonPath](InvalidJsonInput.md#jsonpath) + +### Methods + +- [captureStackTrace](InvalidJsonInput.md#capturestacktrace) + +## Constructors + +### constructor + +• **new InvalidJsonInput**(`field`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `field` | [`Field`](Field.md) | + +#### Overrides + +[InvalidInput](InvalidInput.md).[constructor](InvalidInput.md#constructor) + +#### Defined in + +[lib/error/invalid-input.ts:25](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-input.ts#L25) + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[cause](InvalidInput.md#cause) + +#### Defined in + +node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[message](InvalidInput.md#message) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[name](InvalidInput.md#name) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[stack](InvalidInput.md#stack) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[prepareStackTrace](InvalidInput.md#preparestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[stackTraceLimit](InvalidInput.md#stacktracelimit) + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Accessors + +### fieldName + +• `get` **fieldName**(): `string` + +#### Returns + +`string` + +#### Defined in + +[lib/error/invalid-input.ts:31](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-input.ts#L31) + +___ + +### fieldType + +• `get` **fieldType**(): [`FieldType`](../README.md#fieldtype) + +#### Returns + +[`FieldType`](../README.md#fieldtype) + +#### Defined in + +[lib/error/invalid-input.ts:32](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-input.ts#L32) + +___ + +### jsonPath + +• `get` **jsonPath**(): `string` + +#### Returns + +`string` + +#### Defined in + +[lib/error/invalid-input.ts:33](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-input.ts#L33) + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[captureStackTrace](InvalidInput.md#capturestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/classes/InvalidJsonValue.md b/docs/classes/InvalidJsonValue.md new file mode 100644 index 00000000..637fbee2 --- /dev/null +++ b/docs/classes/InvalidJsonValue.md @@ -0,0 +1,228 @@ +[redis-om](../README.md) / InvalidJsonValue + +# Class: InvalidJsonValue + +## Hierarchy + +- [`InvalidValue`](InvalidValue.md) + + ↳ **`InvalidJsonValue`** + +## Table of contents + +### Constructors + +- [constructor](InvalidJsonValue.md#constructor) + +### Properties + +- [cause](InvalidJsonValue.md#cause) +- [message](InvalidJsonValue.md#message) +- [name](InvalidJsonValue.md#name) +- [stack](InvalidJsonValue.md#stack) +- [prepareStackTrace](InvalidJsonValue.md#preparestacktrace) +- [stackTraceLimit](InvalidJsonValue.md#stacktracelimit) + +### Accessors + +- [fieldName](InvalidJsonValue.md#fieldname) +- [fieldType](InvalidJsonValue.md#fieldtype) +- [jsonPath](InvalidJsonValue.md#jsonpath) + +### Methods + +- [captureStackTrace](InvalidJsonValue.md#capturestacktrace) + +## Constructors + +### constructor + +• **new InvalidJsonValue**(`field`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `field` | [`Field`](Field.md) | + +#### Overrides + +[InvalidValue](InvalidValue.md).[constructor](InvalidValue.md#constructor) + +#### Defined in + +[lib/error/invalid-value.ts:25](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-value.ts#L25) + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[InvalidValue](InvalidValue.md).[cause](InvalidValue.md#cause) + +#### Defined in + +node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[InvalidValue](InvalidValue.md).[message](InvalidValue.md#message) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +[InvalidValue](InvalidValue.md).[name](InvalidValue.md#name) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[InvalidValue](InvalidValue.md).[stack](InvalidValue.md#stack) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +[InvalidValue](InvalidValue.md).[prepareStackTrace](InvalidValue.md#preparestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[InvalidValue](InvalidValue.md).[stackTraceLimit](InvalidValue.md#stacktracelimit) + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Accessors + +### fieldName + +• `get` **fieldName**(): `string` + +#### Returns + +`string` + +#### Defined in + +[lib/error/invalid-value.ts:31](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-value.ts#L31) + +___ + +### fieldType + +• `get` **fieldType**(): [`FieldType`](../README.md#fieldtype) + +#### Returns + +[`FieldType`](../README.md#fieldtype) + +#### Defined in + +[lib/error/invalid-value.ts:32](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-value.ts#L32) + +___ + +### jsonPath + +• `get` **jsonPath**(): `string` + +#### Returns + +`string` + +#### Defined in + +[lib/error/invalid-value.ts:33](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-value.ts#L33) + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +[InvalidValue](InvalidValue.md).[captureStackTrace](InvalidValue.md#capturestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/classes/InvalidSchema.md b/docs/classes/InvalidSchema.md new file mode 100644 index 00000000..c54fa8ea --- /dev/null +++ b/docs/classes/InvalidSchema.md @@ -0,0 +1,197 @@ +[redis-om](../README.md) / InvalidSchema + +# Class: InvalidSchema + +## Hierarchy + +- [`RedisOmError`](RedisOmError.md) + + ↳ **`InvalidSchema`** + +## Table of contents + +### Constructors + +- [constructor](InvalidSchema.md#constructor) + +### Properties + +- [cause](InvalidSchema.md#cause) +- [message](InvalidSchema.md#message) +- [name](InvalidSchema.md#name) +- [stack](InvalidSchema.md#stack) +- [prepareStackTrace](InvalidSchema.md#preparestacktrace) +- [stackTraceLimit](InvalidSchema.md#stacktracelimit) + +### Methods + +- [captureStackTrace](InvalidSchema.md#capturestacktrace) + +## Constructors + +### constructor + +• **new InvalidSchema**(`message?`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Inherited from + +[RedisOmError](RedisOmError.md).[constructor](RedisOmError.md#constructor) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1059 + +• **new InvalidSchema**(`message?`, `options?`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | +| `options?` | `ErrorOptions` | + +#### Inherited from + +[RedisOmError](RedisOmError.md).[constructor](RedisOmError.md#constructor) + +#### Defined in + +node_modules/typescript/lib/lib.es2022.error.d.ts:30 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[cause](RedisOmError.md#cause) + +#### Defined in + +node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[message](RedisOmError.md#message) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[name](RedisOmError.md#name) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[stack](RedisOmError.md#stack) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[prepareStackTrace](RedisOmError.md#preparestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[stackTraceLimit](RedisOmError.md#stacktracelimit) + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[captureStackTrace](RedisOmError.md#capturestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/classes/InvalidValue.md b/docs/classes/InvalidValue.md new file mode 100644 index 00000000..9634ce6e --- /dev/null +++ b/docs/classes/InvalidValue.md @@ -0,0 +1,203 @@ +[redis-om](../README.md) / InvalidValue + +# Class: InvalidValue + +## Hierarchy + +- [`RedisOmError`](RedisOmError.md) + + ↳ **`InvalidValue`** + + ↳↳ [`NullJsonValue`](NullJsonValue.md) + + ↳↳ [`InvalidJsonValue`](InvalidJsonValue.md) + + ↳↳ [`InvalidHashValue`](InvalidHashValue.md) + +## Table of contents + +### Constructors + +- [constructor](InvalidValue.md#constructor) + +### Properties + +- [cause](InvalidValue.md#cause) +- [message](InvalidValue.md#message) +- [name](InvalidValue.md#name) +- [stack](InvalidValue.md#stack) +- [prepareStackTrace](InvalidValue.md#preparestacktrace) +- [stackTraceLimit](InvalidValue.md#stacktracelimit) + +### Methods + +- [captureStackTrace](InvalidValue.md#capturestacktrace) + +## Constructors + +### constructor + +• **new InvalidValue**(`message?`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Inherited from + +[RedisOmError](RedisOmError.md).[constructor](RedisOmError.md#constructor) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1059 + +• **new InvalidValue**(`message?`, `options?`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | +| `options?` | `ErrorOptions` | + +#### Inherited from + +[RedisOmError](RedisOmError.md).[constructor](RedisOmError.md#constructor) + +#### Defined in + +node_modules/typescript/lib/lib.es2022.error.d.ts:30 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[cause](RedisOmError.md#cause) + +#### Defined in + +node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[message](RedisOmError.md#message) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[name](RedisOmError.md#name) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[stack](RedisOmError.md#stack) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[prepareStackTrace](RedisOmError.md#preparestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[stackTraceLimit](RedisOmError.md#stacktracelimit) + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[captureStackTrace](RedisOmError.md#capturestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/classes/NestedHashInput.md b/docs/classes/NestedHashInput.md new file mode 100644 index 00000000..0d65c2d2 --- /dev/null +++ b/docs/classes/NestedHashInput.md @@ -0,0 +1,198 @@ +[redis-om](../README.md) / NestedHashInput + +# Class: NestedHashInput + +## Hierarchy + +- [`InvalidInput`](InvalidInput.md) + + ↳ **`NestedHashInput`** + +## Table of contents + +### Constructors + +- [constructor](NestedHashInput.md#constructor) + +### Properties + +- [cause](NestedHashInput.md#cause) +- [message](NestedHashInput.md#message) +- [name](NestedHashInput.md#name) +- [stack](NestedHashInput.md#stack) +- [prepareStackTrace](NestedHashInput.md#preparestacktrace) +- [stackTraceLimit](NestedHashInput.md#stacktracelimit) + +### Accessors + +- [field](NestedHashInput.md#field) + +### Methods + +- [captureStackTrace](NestedHashInput.md#capturestacktrace) + +## Constructors + +### constructor + +• **new NestedHashInput**(`property`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `property` | `string` | + +#### Overrides + +[InvalidInput](InvalidInput.md).[constructor](InvalidInput.md#constructor) + +#### Defined in + +[lib/error/invalid-input.ts:54](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-input.ts#L54) + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[cause](InvalidInput.md#cause) + +#### Defined in + +node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[message](InvalidInput.md#message) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[name](InvalidInput.md#name) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[stack](InvalidInput.md#stack) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[prepareStackTrace](InvalidInput.md#preparestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[stackTraceLimit](InvalidInput.md#stacktracelimit) + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Accessors + +### field + +• `get` **field**(): `string` + +#### Returns + +`string` + +#### Defined in + +[lib/error/invalid-input.ts:60](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-input.ts#L60) + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[captureStackTrace](InvalidInput.md#capturestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/classes/NullJsonInput.md b/docs/classes/NullJsonInput.md new file mode 100644 index 00000000..e701285a --- /dev/null +++ b/docs/classes/NullJsonInput.md @@ -0,0 +1,228 @@ +[redis-om](../README.md) / NullJsonInput + +# Class: NullJsonInput + +## Hierarchy + +- [`InvalidInput`](InvalidInput.md) + + ↳ **`NullJsonInput`** + +## Table of contents + +### Constructors + +- [constructor](NullJsonInput.md#constructor) + +### Properties + +- [cause](NullJsonInput.md#cause) +- [message](NullJsonInput.md#message) +- [name](NullJsonInput.md#name) +- [stack](NullJsonInput.md#stack) +- [prepareStackTrace](NullJsonInput.md#preparestacktrace) +- [stackTraceLimit](NullJsonInput.md#stacktracelimit) + +### Accessors + +- [fieldName](NullJsonInput.md#fieldname) +- [fieldType](NullJsonInput.md#fieldtype) +- [jsonPath](NullJsonInput.md#jsonpath) + +### Methods + +- [captureStackTrace](NullJsonInput.md#capturestacktrace) + +## Constructors + +### constructor + +• **new NullJsonInput**(`field`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `field` | [`Field`](Field.md) | + +#### Overrides + +[InvalidInput](InvalidInput.md).[constructor](InvalidInput.md#constructor) + +#### Defined in + +[lib/error/invalid-input.ts:10](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-input.ts#L10) + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[cause](InvalidInput.md#cause) + +#### Defined in + +node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[message](InvalidInput.md#message) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[name](InvalidInput.md#name) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[stack](InvalidInput.md#stack) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[prepareStackTrace](InvalidInput.md#preparestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[stackTraceLimit](InvalidInput.md#stacktracelimit) + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Accessors + +### fieldName + +• `get` **fieldName**(): `string` + +#### Returns + +`string` + +#### Defined in + +[lib/error/invalid-input.ts:16](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-input.ts#L16) + +___ + +### fieldType + +• `get` **fieldType**(): [`FieldType`](../README.md#fieldtype) + +#### Returns + +[`FieldType`](../README.md#fieldtype) + +#### Defined in + +[lib/error/invalid-input.ts:17](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-input.ts#L17) + +___ + +### jsonPath + +• `get` **jsonPath**(): `string` + +#### Returns + +`string` + +#### Defined in + +[lib/error/invalid-input.ts:18](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-input.ts#L18) + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +[InvalidInput](InvalidInput.md).[captureStackTrace](InvalidInput.md#capturestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/classes/NullJsonValue.md b/docs/classes/NullJsonValue.md new file mode 100644 index 00000000..0834d0ec --- /dev/null +++ b/docs/classes/NullJsonValue.md @@ -0,0 +1,228 @@ +[redis-om](../README.md) / NullJsonValue + +# Class: NullJsonValue + +## Hierarchy + +- [`InvalidValue`](InvalidValue.md) + + ↳ **`NullJsonValue`** + +## Table of contents + +### Constructors + +- [constructor](NullJsonValue.md#constructor) + +### Properties + +- [cause](NullJsonValue.md#cause) +- [message](NullJsonValue.md#message) +- [name](NullJsonValue.md#name) +- [stack](NullJsonValue.md#stack) +- [prepareStackTrace](NullJsonValue.md#preparestacktrace) +- [stackTraceLimit](NullJsonValue.md#stacktracelimit) + +### Accessors + +- [fieldName](NullJsonValue.md#fieldname) +- [fieldType](NullJsonValue.md#fieldtype) +- [jsonPath](NullJsonValue.md#jsonpath) + +### Methods + +- [captureStackTrace](NullJsonValue.md#capturestacktrace) + +## Constructors + +### constructor + +• **new NullJsonValue**(`field`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `field` | [`Field`](Field.md) | + +#### Overrides + +[InvalidValue](InvalidValue.md).[constructor](InvalidValue.md#constructor) + +#### Defined in + +[lib/error/invalid-value.ts:10](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-value.ts#L10) + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[InvalidValue](InvalidValue.md).[cause](InvalidValue.md#cause) + +#### Defined in + +node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[InvalidValue](InvalidValue.md).[message](InvalidValue.md#message) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +[InvalidValue](InvalidValue.md).[name](InvalidValue.md#name) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[InvalidValue](InvalidValue.md).[stack](InvalidValue.md#stack) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +[InvalidValue](InvalidValue.md).[prepareStackTrace](InvalidValue.md#preparestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[InvalidValue](InvalidValue.md).[stackTraceLimit](InvalidValue.md#stacktracelimit) + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Accessors + +### fieldName + +• `get` **fieldName**(): `string` + +#### Returns + +`string` + +#### Defined in + +[lib/error/invalid-value.ts:16](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-value.ts#L16) + +___ + +### fieldType + +• `get` **fieldType**(): [`FieldType`](../README.md#fieldtype) + +#### Returns + +[`FieldType`](../README.md#fieldtype) + +#### Defined in + +[lib/error/invalid-value.ts:17](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-value.ts#L17) + +___ + +### jsonPath + +• `get` **jsonPath**(): `string` + +#### Returns + +`string` + +#### Defined in + +[lib/error/invalid-value.ts:18](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/invalid-value.ts#L18) + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +[InvalidValue](InvalidValue.md).[captureStackTrace](InvalidValue.md#capturestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/classes/PointOutOfRange.md b/docs/classes/PointOutOfRange.md new file mode 100644 index 00000000..7d82ac94 --- /dev/null +++ b/docs/classes/PointOutOfRange.md @@ -0,0 +1,203 @@ +[redis-om](../README.md) / PointOutOfRange + +# Class: PointOutOfRange + +## Hierarchy + +- [`RedisOmError`](RedisOmError.md) + + ↳ **`PointOutOfRange`** + +## Table of contents + +### Constructors + +- [constructor](PointOutOfRange.md#constructor) + +### Properties + +- [cause](PointOutOfRange.md#cause) +- [message](PointOutOfRange.md#message) +- [name](PointOutOfRange.md#name) +- [stack](PointOutOfRange.md#stack) +- [prepareStackTrace](PointOutOfRange.md#preparestacktrace) +- [stackTraceLimit](PointOutOfRange.md#stacktracelimit) + +### Accessors + +- [point](PointOutOfRange.md#point) + +### Methods + +- [captureStackTrace](PointOutOfRange.md#capturestacktrace) + +## Constructors + +### constructor + +• **new PointOutOfRange**(`point`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `point` | [`Point`](../README.md#point) | + +#### Overrides + +[RedisOmError](RedisOmError.md).[constructor](RedisOmError.md#constructor) + +#### Defined in + +[lib/error/point-out-of-range.ts:9](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/point-out-of-range.ts#L9) + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[cause](RedisOmError.md#cause) + +#### Defined in + +node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[message](RedisOmError.md#message) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[name](RedisOmError.md#name) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[stack](RedisOmError.md#stack) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[prepareStackTrace](RedisOmError.md#preparestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[stackTraceLimit](RedisOmError.md#stacktracelimit) + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Accessors + +### point + +• `get` **point**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `latitude` | `number` | +| `longitude` | `number` | + +#### Defined in + +[lib/error/point-out-of-range.ts:15](https://github.com/redis/redis-om-node/blob/5777b6c/lib/error/point-out-of-range.ts#L15) + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[captureStackTrace](RedisOmError.md#capturestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/classes/RawSearch.md b/docs/classes/RawSearch.md index 0a99b757..826aff76 100644 --- a/docs/classes/RawSearch.md +++ b/docs/classes/RawSearch.md @@ -82,7 +82,7 @@ AbstractSearch.return #### Defined in -[lib/search/search.ts:308](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L308) +[lib/search/search.ts:308](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L308) ## Methods @@ -118,7 +118,7 @@ An array of [Entities](../README.md#entity) matching the query. #### Defined in -[lib/search/search.ts:264](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L264) +[lib/search/search.ts:264](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L264) ___ @@ -154,7 +154,7 @@ An array of entity IDs matching the query. #### Defined in -[lib/search/search.ts:282](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L282) +[lib/search/search.ts:282](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L282) ___ @@ -190,7 +190,7 @@ An array of key names matching the query. #### Defined in -[lib/search/search.ts:300](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L300) +[lib/search/search.ts:300](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L300) ___ @@ -210,7 +210,7 @@ Returns the number of [Entities](../README.md#entity) that match this query. #### Defined in -[lib/search/search.ts:188](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L188) +[lib/search/search.ts:188](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L188) ___ @@ -230,7 +230,7 @@ Returns the first [Entity](../README.md#entity) that matches this query. #### Defined in -[lib/search/search.ts:229](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L229) +[lib/search/search.ts:229](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L229) ___ @@ -250,7 +250,7 @@ Returns the first entity ID that matches this query. #### Defined in -[lib/search/search.ts:237](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L237) +[lib/search/search.ts:237](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L237) ___ @@ -270,7 +270,7 @@ Returns the first key name that matches this query. #### Defined in -[lib/search/search.ts:245](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L245) +[lib/search/search.ts:245](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L245) ___ @@ -298,7 +298,7 @@ The entity ID [Entity](../README.md#entity) with the maximal value #### Defined in -[lib/search/search.ts:162](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L162) +[lib/search/search.ts:162](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L162) ___ @@ -326,7 +326,7 @@ The entity ID with the maximal value #### Defined in -[lib/search/search.ts:171](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L171) +[lib/search/search.ts:171](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L171) ___ @@ -354,7 +354,7 @@ The key name with the maximal value #### Defined in -[lib/search/search.ts:180](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L180) +[lib/search/search.ts:180](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L180) ___ @@ -382,7 +382,7 @@ The [Entity](../README.md#entity) with the minimal value #### Defined in -[lib/search/search.ts:135](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L135) +[lib/search/search.ts:135](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L135) ___ @@ -410,7 +410,7 @@ The entity ID with the minimal value #### Defined in -[lib/search/search.ts:144](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L144) +[lib/search/search.ts:144](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L144) ___ @@ -438,7 +438,7 @@ The key name with the minimal value #### Defined in -[lib/search/search.ts:153](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L153) +[lib/search/search.ts:153](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L153) ___ @@ -467,7 +467,7 @@ An array of [Entities](../README.md#entity) matching the query. #### Defined in -[lib/search/search.ts:199](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L199) +[lib/search/search.ts:199](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L199) ___ @@ -496,7 +496,7 @@ An array of strings matching the query. #### Defined in -[lib/search/search.ts:210](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L210) +[lib/search/search.ts:210](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L210) ___ @@ -525,7 +525,7 @@ An array of strings matching the query. #### Defined in -[lib/search/search.ts:221](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L221) +[lib/search/search.ts:221](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L221) ___ @@ -552,7 +552,7 @@ Alias for [all](Search.md#all). #### Defined in -[lib/search/search.ts:406](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L406) +[lib/search/search.ts:406](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L406) ___ @@ -579,7 +579,7 @@ Alias for [allIds](Search.md#allids). #### Defined in -[lib/search/search.ts:413](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L413) +[lib/search/search.ts:413](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L413) ___ @@ -606,7 +606,7 @@ Alias for [allKeys](Search.md#allkeys). #### Defined in -[lib/search/search.ts:420](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L420) +[lib/search/search.ts:420](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L420) ___ @@ -626,7 +626,7 @@ Alias for [count](Search.md#count). #### Defined in -[lib/search/search.ts:357](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L357) +[lib/search/search.ts:357](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L357) ___ @@ -646,7 +646,7 @@ Alias for [first](Search.md#first). #### Defined in -[lib/search/search.ts:385](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L385) +[lib/search/search.ts:385](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L385) ___ @@ -666,7 +666,7 @@ Alias for [firstId](Search.md#firstid). #### Defined in -[lib/search/search.ts:392](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L392) +[lib/search/search.ts:392](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L392) ___ @@ -686,7 +686,7 @@ Alias for [firstKey](Search.md#firstkey). #### Defined in -[lib/search/search.ts:399](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L399) +[lib/search/search.ts:399](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L399) ___ @@ -712,7 +712,7 @@ Alias for [max](Search.md#max). #### Defined in -[lib/search/search.ts:336](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L336) +[lib/search/search.ts:336](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L336) ___ @@ -738,7 +738,7 @@ Alias for [maxId](Search.md#maxid). #### Defined in -[lib/search/search.ts:343](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L343) +[lib/search/search.ts:343](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L343) ___ @@ -764,7 +764,7 @@ Alias for [maxKey](Search.md#maxkey). #### Defined in -[lib/search/search.ts:350](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L350) +[lib/search/search.ts:350](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L350) ___ @@ -790,7 +790,7 @@ Alias for [min](Search.md#min). #### Defined in -[lib/search/search.ts:315](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L315) +[lib/search/search.ts:315](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L315) ___ @@ -816,7 +816,7 @@ Alias for [minId](Search.md#minid). #### Defined in -[lib/search/search.ts:322](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L322) +[lib/search/search.ts:322](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L322) ___ @@ -842,7 +842,7 @@ Alias for [minKey](Search.md#minkey). #### Defined in -[lib/search/search.ts:329](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L329) +[lib/search/search.ts:329](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L329) ___ @@ -869,7 +869,7 @@ Alias for [page](Search.md#page). #### Defined in -[lib/search/search.ts:364](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L364) +[lib/search/search.ts:364](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L364) ___ @@ -896,7 +896,7 @@ Alias for [pageOfIds](Search.md#pageofids). #### Defined in -[lib/search/search.ts:371](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L371) +[lib/search/search.ts:371](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L371) ___ @@ -923,7 +923,7 @@ Alias for [pageOfKeys](Search.md#pageofkeys). #### Defined in -[lib/search/search.ts:378](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L378) +[lib/search/search.ts:378](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L378) ___ @@ -949,7 +949,7 @@ Alias for [sortAscending](Search.md#sortascending). #### Defined in -[lib/search/search.ts:86](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L86) +[lib/search/search.ts:86](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L86) ___ @@ -977,7 +977,7 @@ this #### Defined in -[lib/search/search.ts:63](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L63) +[lib/search/search.ts:63](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L63) ___ @@ -1006,7 +1006,7 @@ this #### Defined in -[lib/search/search.ts:96](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L96) +[lib/search/search.ts:96](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L96) ___ @@ -1032,7 +1032,7 @@ Alias for [sortDescending](Search.md#sortdescending). #### Defined in -[lib/search/search.ts:70](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L70) +[lib/search/search.ts:70](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L70) ___ @@ -1060,4 +1060,4 @@ this #### Defined in -[lib/search/search.ts:79](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L79) +[lib/search/search.ts:79](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L79) diff --git a/docs/classes/RedisOmError.md b/docs/classes/RedisOmError.md index a68102e7..a20e7897 100644 --- a/docs/classes/RedisOmError.md +++ b/docs/classes/RedisOmError.md @@ -8,6 +8,16 @@ ↳ **`RedisOmError`** + ↳↳ [`InvalidInput`](InvalidInput.md) + + ↳↳ [`InvalidSchema`](InvalidSchema.md) + + ↳↳ [`InvalidValue`](InvalidValue.md) + + ↳↳ [`PointOutOfRange`](PointOutOfRange.md) + + ↳↳ [`SearchError`](SearchError.md) + ## Table of contents ### Constructors diff --git a/docs/classes/Repository.md b/docs/classes/Repository.md index 820e4595..8e45a31e 100644 --- a/docs/classes/Repository.md +++ b/docs/classes/Repository.md @@ -71,7 +71,7 @@ Creates a new [Repository](Repository.md). #### Defined in -[lib/repository/repository.ts:56](https://github.com/redis/redis-om-node/blob/e552415/lib/repository/repository.ts#L56) +[lib/repository/repository.ts:56](https://github.com/redis/redis-om-node/blob/5777b6c/lib/repository/repository.ts#L56) ## Methods @@ -89,7 +89,7 @@ RediSearch and RedisJSON are installed on your instance of Redis. #### Defined in -[lib/repository/repository.ts:71](https://github.com/redis/redis-om-node/blob/e552415/lib/repository/repository.ts#L71) +[lib/repository/repository.ts:71](https://github.com/redis/redis-om-node/blob/5777b6c/lib/repository/repository.ts#L71) ___ @@ -107,7 +107,7 @@ on your instance of Redis. #### Defined in -[lib/repository/repository.ts:109](https://github.com/redis/redis-om-node/blob/e552415/lib/repository/repository.ts#L109) +[lib/repository/repository.ts:109](https://github.com/redis/redis-om-node/blob/5777b6c/lib/repository/repository.ts#L109) ___ @@ -131,7 +131,7 @@ found, does nothing. #### Defined in -[lib/repository/repository.ts:242](https://github.com/redis/redis-om-node/blob/e552415/lib/repository/repository.ts#L242) +[lib/repository/repository.ts:242](https://github.com/redis/redis-om-node/blob/5777b6c/lib/repository/repository.ts#L242) ▸ **expire**(`ids`, `ttlInSeconds`): `Promise`<`void`\> @@ -151,7 +151,7 @@ ids. If a particular [Entity](../README.md#entity) is not found, does nothing. #### Defined in -[lib/repository/repository.ts:250](https://github.com/redis/redis-om-node/blob/e552415/lib/repository/repository.ts#L250) +[lib/repository/repository.ts:250](https://github.com/redis/redis-om-node/blob/5777b6c/lib/repository/repository.ts#L250) ___ @@ -176,7 +176,7 @@ The matching Entity. #### Defined in -[lib/repository/repository.ts:171](https://github.com/redis/redis-om-node/blob/e552415/lib/repository/repository.ts#L171) +[lib/repository/repository.ts:171](https://github.com/redis/redis-om-node/blob/5777b6c/lib/repository/repository.ts#L171) ▸ **fetch**(`...ids`): `Promise`<[`Entity`](../README.md#entity)[]\> @@ -197,7 +197,7 @@ The matching Entities. #### Defined in -[lib/repository/repository.ts:180](https://github.com/redis/redis-om-node/blob/e552415/lib/repository/repository.ts#L180) +[lib/repository/repository.ts:180](https://github.com/redis/redis-om-node/blob/5777b6c/lib/repository/repository.ts#L180) ▸ **fetch**(`ids`): `Promise`<[`Entity`](../README.md#entity)[]\> @@ -218,7 +218,7 @@ The matching Entities. #### Defined in -[lib/repository/repository.ts:189](https://github.com/redis/redis-om-node/blob/e552415/lib/repository/repository.ts#L189) +[lib/repository/repository.ts:189](https://github.com/redis/redis-om-node/blob/5777b6c/lib/repository/repository.ts#L189) ___ @@ -241,7 +241,7 @@ not found, does nothing. #### Defined in -[lib/repository/repository.ts:205](https://github.com/redis/redis-om-node/blob/e552415/lib/repository/repository.ts#L205) +[lib/repository/repository.ts:205](https://github.com/redis/redis-om-node/blob/5777b6c/lib/repository/repository.ts#L205) ▸ **remove**(`...ids`): `Promise`<`void`\> @@ -260,7 +260,7 @@ particular [Entity](../README.md#entity) is not found, does nothing. #### Defined in -[lib/repository/repository.ts:213](https://github.com/redis/redis-om-node/blob/e552415/lib/repository/repository.ts#L213) +[lib/repository/repository.ts:213](https://github.com/redis/redis-om-node/blob/5777b6c/lib/repository/repository.ts#L213) ▸ **remove**(`ids`): `Promise`<`void`\> @@ -279,7 +279,7 @@ particular [Entity](../README.md#entity) is not found, does nothing. #### Defined in -[lib/repository/repository.ts:221](https://github.com/redis/redis-om-node/blob/e552415/lib/repository/repository.ts#L221) +[lib/repository/repository.ts:221](https://github.com/redis/redis-om-node/blob/5777b6c/lib/repository/repository.ts#L221) ___ @@ -304,7 +304,7 @@ A copy of the provided Entity with EntityId and EntityKeyName properties added. #### Defined in -[lib/repository/repository.ts:134](https://github.com/redis/redis-om-node/blob/e552415/lib/repository/repository.ts#L134) +[lib/repository/repository.ts:134](https://github.com/redis/redis-om-node/blob/5777b6c/lib/repository/repository.ts#L134) ▸ **save**(`id`, `entity`): `Promise`<[`Entity`](../README.md#entity)\> @@ -325,7 +325,7 @@ A copy of the provided Entity with EntityId and EntityKeyName properties added. #### Defined in -[lib/repository/repository.ts:143](https://github.com/redis/redis-om-node/blob/e552415/lib/repository/repository.ts#L143) +[lib/repository/repository.ts:143](https://github.com/redis/redis-om-node/blob/5777b6c/lib/repository/repository.ts#L143) ___ @@ -344,7 +344,7 @@ A [Search](Search.md) object. #### Defined in -[lib/repository/repository.ts:268](https://github.com/redis/redis-om-node/blob/e552415/lib/repository/repository.ts#L268) +[lib/repository/repository.ts:268](https://github.com/redis/redis-om-node/blob/5777b6c/lib/repository/repository.ts#L268) ___ @@ -377,4 +377,4 @@ A [RawSearch](RawSearch.md) object. #### Defined in -[lib/repository/repository.ts:283](https://github.com/redis/redis-om-node/blob/e552415/lib/repository/repository.ts#L283) +[lib/repository/repository.ts:283](https://github.com/redis/redis-om-node/blob/5777b6c/lib/repository/repository.ts#L283) diff --git a/docs/classes/Schema.md b/docs/classes/Schema.md index a247e5e9..77edbbc3 100644 --- a/docs/classes/Schema.md +++ b/docs/classes/Schema.md @@ -63,7 +63,7 @@ Constructs a Schema. #### Defined in -[lib/schema/schema.ts:48](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/schema.ts#L48) +[lib/schema/schema.ts:49](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/schema.ts#L49) ## Accessors @@ -80,7 +80,7 @@ that this Schema uses to store [Entities](../README.md#entity) in Redis. #### Defined in -[lib/schema/schema.ts:91](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/schema.ts#L91) +[lib/schema/schema.ts:92](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/schema.ts#L92) ___ @@ -96,7 +96,7 @@ The [Fields](Field.md) defined by this Schema. #### Defined in -[lib/schema/schema.ts:67](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/schema.ts#L67) +[lib/schema/schema.ts:68](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/schema.ts#L68) ___ @@ -113,7 +113,7 @@ changed when calling [createIndex](Repository.md#createindex). #### Defined in -[lib/schema/schema.ts:119](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/schema.ts#L119) +[lib/schema/schema.ts:120](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/schema.ts#L120) ___ @@ -129,7 +129,7 @@ The configured name for the RediSearch index hash for this Schema. #### Defined in -[lib/schema/schema.ts:85](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/schema.ts#L85) +[lib/schema/schema.ts:86](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/schema.ts#L86) ___ @@ -145,7 +145,7 @@ The configured name for the RediSearch index for this Schema. #### Defined in -[lib/schema/schema.ts:82](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/schema.ts#L82) +[lib/schema/schema.ts:83](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/schema.ts#L83) ___ @@ -163,7 +163,7 @@ idStrategy returns `12345` then the generated key would be `foo:12345`. #### Defined in -[lib/schema/schema.ts:62](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/schema.ts#L62) +[lib/schema/schema.ts:63](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/schema.ts#L63) ___ @@ -180,7 +180,7 @@ than `CUSTOM`. #### Defined in -[lib/schema/schema.ts:103](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/schema.ts#L103) +[lib/schema/schema.ts:104](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/schema.ts#L104) ___ @@ -197,7 +197,7 @@ or `CUSTOM`. See [SchemaOptions](../README.md#schemaoptions) for more details. #### Defined in -[lib/schema/schema.ts:97](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/schema.ts#L97) +[lib/schema/schema.ts:98](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/schema.ts#L98) ## Methods @@ -221,7 +221,7 @@ The [Field](Field.md), or null of not found. #### Defined in -[lib/schema/schema.ts:77](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/schema.ts#L77) +[lib/schema/schema.ts:78](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/schema.ts#L78) ___ @@ -239,4 +239,4 @@ The generated id. #### Defined in -[lib/schema/schema.ts:110](https://github.com/redis/redis-om-node/blob/e552415/lib/schema/schema.ts#L110) +[lib/schema/schema.ts:111](https://github.com/redis/redis-om-node/blob/5777b6c/lib/schema/schema.ts#L111) diff --git a/docs/classes/Search.md b/docs/classes/Search.md index f20f33ff..edf21628 100644 --- a/docs/classes/Search.md +++ b/docs/classes/Search.md @@ -84,7 +84,7 @@ AbstractSearch.return #### Defined in -[lib/search/search.ts:308](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L308) +[lib/search/search.ts:308](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L308) ## Methods @@ -120,7 +120,7 @@ An array of [Entities](../README.md#entity) matching the query. #### Defined in -[lib/search/search.ts:264](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L264) +[lib/search/search.ts:264](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L264) ___ @@ -156,7 +156,7 @@ An array of entity IDs matching the query. #### Defined in -[lib/search/search.ts:282](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L282) +[lib/search/search.ts:282](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L282) ___ @@ -192,7 +192,7 @@ An array of key names matching the query. #### Defined in -[lib/search/search.ts:300](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L300) +[lib/search/search.ts:300](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L300) ___ @@ -216,7 +216,7 @@ A subclass of [WhereField](WhereField.md) matching the type of the field. #### Defined in -[lib/search/search.ts:530](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L530) +[lib/search/search.ts:530](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L530) ▸ **and**(`subSearchFn`): [`Search`](Search.md) @@ -236,7 +236,7 @@ Sets up a nested search as a logical AND. #### Defined in -[lib/search/search.ts:537](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L537) +[lib/search/search.ts:537](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L537) ___ @@ -256,7 +256,7 @@ Returns the number of [Entities](../README.md#entity) that match this query. #### Defined in -[lib/search/search.ts:188](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L188) +[lib/search/search.ts:188](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L188) ___ @@ -276,7 +276,7 @@ Returns the first [Entity](../README.md#entity) that matches this query. #### Defined in -[lib/search/search.ts:229](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L229) +[lib/search/search.ts:229](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L229) ___ @@ -296,7 +296,7 @@ Returns the first entity ID that matches this query. #### Defined in -[lib/search/search.ts:237](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L237) +[lib/search/search.ts:237](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L237) ___ @@ -316,7 +316,7 @@ Returns the first key name that matches this query. #### Defined in -[lib/search/search.ts:245](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L245) +[lib/search/search.ts:245](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L245) ___ @@ -344,7 +344,7 @@ The entity ID [Entity](../README.md#entity) with the maximal value #### Defined in -[lib/search/search.ts:162](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L162) +[lib/search/search.ts:162](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L162) ___ @@ -372,7 +372,7 @@ The entity ID with the maximal value #### Defined in -[lib/search/search.ts:171](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L171) +[lib/search/search.ts:171](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L171) ___ @@ -400,7 +400,7 @@ The key name with the maximal value #### Defined in -[lib/search/search.ts:180](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L180) +[lib/search/search.ts:180](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L180) ___ @@ -428,7 +428,7 @@ The [Entity](../README.md#entity) with the minimal value #### Defined in -[lib/search/search.ts:135](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L135) +[lib/search/search.ts:135](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L135) ___ @@ -456,7 +456,7 @@ The entity ID with the minimal value #### Defined in -[lib/search/search.ts:144](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L144) +[lib/search/search.ts:144](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L144) ___ @@ -484,7 +484,7 @@ The key name with the minimal value #### Defined in -[lib/search/search.ts:153](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L153) +[lib/search/search.ts:153](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L153) ___ @@ -508,7 +508,7 @@ A subclass of [WhereField](WhereField.md) matching the type of the field. #### Defined in -[lib/search/search.ts:547](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L547) +[lib/search/search.ts:547](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L547) ▸ **or**(`subSearchFn`): [`Search`](Search.md) @@ -528,7 +528,7 @@ Sets up a nested search as a logical OR. #### Defined in -[lib/search/search.ts:554](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L554) +[lib/search/search.ts:554](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L554) ___ @@ -557,7 +557,7 @@ An array of [Entities](../README.md#entity) matching the query. #### Defined in -[lib/search/search.ts:199](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L199) +[lib/search/search.ts:199](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L199) ___ @@ -586,7 +586,7 @@ An array of strings matching the query. #### Defined in -[lib/search/search.ts:210](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L210) +[lib/search/search.ts:210](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L210) ___ @@ -615,7 +615,7 @@ An array of strings matching the query. #### Defined in -[lib/search/search.ts:221](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L221) +[lib/search/search.ts:221](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L221) ___ @@ -642,7 +642,7 @@ Alias for [all](Search.md#all). #### Defined in -[lib/search/search.ts:406](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L406) +[lib/search/search.ts:406](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L406) ___ @@ -669,7 +669,7 @@ Alias for [allIds](Search.md#allids). #### Defined in -[lib/search/search.ts:413](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L413) +[lib/search/search.ts:413](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L413) ___ @@ -696,7 +696,7 @@ Alias for [allKeys](Search.md#allkeys). #### Defined in -[lib/search/search.ts:420](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L420) +[lib/search/search.ts:420](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L420) ___ @@ -716,7 +716,7 @@ Alias for [count](Search.md#count). #### Defined in -[lib/search/search.ts:357](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L357) +[lib/search/search.ts:357](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L357) ___ @@ -736,7 +736,7 @@ Alias for [first](Search.md#first). #### Defined in -[lib/search/search.ts:385](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L385) +[lib/search/search.ts:385](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L385) ___ @@ -756,7 +756,7 @@ Alias for [firstId](Search.md#firstid). #### Defined in -[lib/search/search.ts:392](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L392) +[lib/search/search.ts:392](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L392) ___ @@ -776,7 +776,7 @@ Alias for [firstKey](Search.md#firstkey). #### Defined in -[lib/search/search.ts:399](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L399) +[lib/search/search.ts:399](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L399) ___ @@ -802,7 +802,7 @@ Alias for [max](Search.md#max). #### Defined in -[lib/search/search.ts:336](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L336) +[lib/search/search.ts:336](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L336) ___ @@ -828,7 +828,7 @@ Alias for [maxId](Search.md#maxid). #### Defined in -[lib/search/search.ts:343](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L343) +[lib/search/search.ts:343](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L343) ___ @@ -854,7 +854,7 @@ Alias for [maxKey](Search.md#maxkey). #### Defined in -[lib/search/search.ts:350](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L350) +[lib/search/search.ts:350](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L350) ___ @@ -880,7 +880,7 @@ Alias for [min](Search.md#min). #### Defined in -[lib/search/search.ts:315](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L315) +[lib/search/search.ts:315](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L315) ___ @@ -906,7 +906,7 @@ Alias for [minId](Search.md#minid). #### Defined in -[lib/search/search.ts:322](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L322) +[lib/search/search.ts:322](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L322) ___ @@ -932,7 +932,7 @@ Alias for [minKey](Search.md#minkey). #### Defined in -[lib/search/search.ts:329](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L329) +[lib/search/search.ts:329](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L329) ___ @@ -959,7 +959,7 @@ Alias for [page](Search.md#page). #### Defined in -[lib/search/search.ts:364](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L364) +[lib/search/search.ts:364](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L364) ___ @@ -986,7 +986,7 @@ Alias for [pageOfIds](Search.md#pageofids). #### Defined in -[lib/search/search.ts:371](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L371) +[lib/search/search.ts:371](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L371) ___ @@ -1013,7 +1013,7 @@ Alias for [pageOfKeys](Search.md#pageofkeys). #### Defined in -[lib/search/search.ts:378](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L378) +[lib/search/search.ts:378](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L378) ___ @@ -1039,7 +1039,7 @@ Alias for [sortAscending](Search.md#sortascending). #### Defined in -[lib/search/search.ts:86](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L86) +[lib/search/search.ts:86](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L86) ___ @@ -1067,7 +1067,7 @@ this #### Defined in -[lib/search/search.ts:63](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L63) +[lib/search/search.ts:63](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L63) ___ @@ -1096,7 +1096,7 @@ this #### Defined in -[lib/search/search.ts:96](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L96) +[lib/search/search.ts:96](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L96) ___ @@ -1122,7 +1122,7 @@ Alias for [sortDescending](Search.md#sortdescending). #### Defined in -[lib/search/search.ts:70](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L70) +[lib/search/search.ts:70](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L70) ___ @@ -1150,7 +1150,7 @@ this #### Defined in -[lib/search/search.ts:79](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L79) +[lib/search/search.ts:79](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L79) ___ @@ -1175,7 +1175,7 @@ A subclass of [WhereField](WhereField.md) matching the type of the field. #### Defined in -[lib/search/search.ts:512](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L512) +[lib/search/search.ts:512](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L512) ▸ **where**(`subSearchFn`): [`Search`](Search.md) @@ -1196,4 +1196,4 @@ they are treated logically as AND. #### Defined in -[lib/search/search.ts:520](https://github.com/redis/redis-om-node/blob/e552415/lib/search/search.ts#L520) +[lib/search/search.ts:520](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/search.ts#L520) diff --git a/docs/classes/SearchError.md b/docs/classes/SearchError.md new file mode 100644 index 00000000..c60d5b54 --- /dev/null +++ b/docs/classes/SearchError.md @@ -0,0 +1,201 @@ +[redis-om](../README.md) / SearchError + +# Class: SearchError + +## Hierarchy + +- [`RedisOmError`](RedisOmError.md) + + ↳ **`SearchError`** + + ↳↳ [`SemanticSearchError`](SemanticSearchError.md) + + ↳↳ [`FieldNotInSchema`](FieldNotInSchema.md) + +## Table of contents + +### Constructors + +- [constructor](SearchError.md#constructor) + +### Properties + +- [cause](SearchError.md#cause) +- [message](SearchError.md#message) +- [name](SearchError.md#name) +- [stack](SearchError.md#stack) +- [prepareStackTrace](SearchError.md#preparestacktrace) +- [stackTraceLimit](SearchError.md#stacktracelimit) + +### Methods + +- [captureStackTrace](SearchError.md#capturestacktrace) + +## Constructors + +### constructor + +• **new SearchError**(`message?`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Inherited from + +[RedisOmError](RedisOmError.md).[constructor](RedisOmError.md#constructor) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1059 + +• **new SearchError**(`message?`, `options?`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | +| `options?` | `ErrorOptions` | + +#### Inherited from + +[RedisOmError](RedisOmError.md).[constructor](RedisOmError.md#constructor) + +#### Defined in + +node_modules/typescript/lib/lib.es2022.error.d.ts:30 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[cause](RedisOmError.md#cause) + +#### Defined in + +node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[message](RedisOmError.md#message) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[name](RedisOmError.md#name) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[stack](RedisOmError.md#stack) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[prepareStackTrace](RedisOmError.md#preparestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[stackTraceLimit](RedisOmError.md#stacktracelimit) + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +[RedisOmError](RedisOmError.md).[captureStackTrace](RedisOmError.md#capturestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/classes/SemanticSearchError.md b/docs/classes/SemanticSearchError.md new file mode 100644 index 00000000..f21e1208 --- /dev/null +++ b/docs/classes/SemanticSearchError.md @@ -0,0 +1,197 @@ +[redis-om](../README.md) / SemanticSearchError + +# Class: SemanticSearchError + +## Hierarchy + +- [`SearchError`](SearchError.md) + + ↳ **`SemanticSearchError`** + +## Table of contents + +### Constructors + +- [constructor](SemanticSearchError.md#constructor) + +### Properties + +- [cause](SemanticSearchError.md#cause) +- [message](SemanticSearchError.md#message) +- [name](SemanticSearchError.md#name) +- [stack](SemanticSearchError.md#stack) +- [prepareStackTrace](SemanticSearchError.md#preparestacktrace) +- [stackTraceLimit](SemanticSearchError.md#stacktracelimit) + +### Methods + +- [captureStackTrace](SemanticSearchError.md#capturestacktrace) + +## Constructors + +### constructor + +• **new SemanticSearchError**(`message?`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Inherited from + +[SearchError](SearchError.md).[constructor](SearchError.md#constructor) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1059 + +• **new SemanticSearchError**(`message?`, `options?`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | +| `options?` | `ErrorOptions` | + +#### Inherited from + +[SearchError](SearchError.md).[constructor](SearchError.md#constructor) + +#### Defined in + +node_modules/typescript/lib/lib.es2022.error.d.ts:30 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[SearchError](SearchError.md).[cause](SearchError.md#cause) + +#### Defined in + +node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[SearchError](SearchError.md).[message](SearchError.md#message) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +[SearchError](SearchError.md).[name](SearchError.md#name) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[SearchError](SearchError.md).[stack](SearchError.md#stack) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +[SearchError](SearchError.md).[prepareStackTrace](SearchError.md#preparestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[SearchError](SearchError.md).[stackTraceLimit](SearchError.md#stacktracelimit) + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +[SearchError](SearchError.md).[captureStackTrace](SearchError.md#capturestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/classes/Where.md b/docs/classes/Where.md index 1aca47e0..273efe03 100644 --- a/docs/classes/Where.md +++ b/docs/classes/Where.md @@ -40,4 +40,4 @@ Converts this [Where](Where.md) into a portion of a RediSearch query. #### Defined in -[lib/search/where.ts:8](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where.ts#L8) +[lib/search/where.ts:8](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where.ts#L8) diff --git a/docs/classes/WhereField.md b/docs/classes/WhereField.md index 35f87f45..eef49b67 100644 --- a/docs/classes/WhereField.md +++ b/docs/classes/WhereField.md @@ -71,7 +71,7 @@ this multiple times will have no effect. #### Defined in -[lib/search/where-field.ts:92](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L92) +[lib/search/where-field.ts:92](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L92) ___ @@ -84,7 +84,7 @@ this multiple times will have no effect. #### Defined in -[lib/search/where-field.ts:99](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L99) +[lib/search/where-field.ts:99](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L99) ## Accessors @@ -102,7 +102,7 @@ this #### Defined in -[lib/search/where-field.ts:289](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L289) +[lib/search/where-field.ts:289](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L289) ___ @@ -120,7 +120,7 @@ this #### Defined in -[lib/search/where-field.ts:281](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L281) +[lib/search/where-field.ts:281](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L281) ___ @@ -139,7 +139,7 @@ this #### Defined in -[lib/search/where-field.ts:298](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L298) +[lib/search/where-field.ts:298](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L298) ## Methods @@ -163,7 +163,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:240](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L240) +[lib/search/where-field.ts:240](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L240) ___ @@ -187,7 +187,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:233](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L233) +[lib/search/where-field.ts:233](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L233) ___ @@ -212,7 +212,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:175](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L175) +[lib/search/where-field.ts:175](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L175) ___ @@ -236,7 +236,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:182](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L182) +[lib/search/where-field.ts:182](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L182) ___ @@ -261,7 +261,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:197](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L197) +[lib/search/where-field.ts:197](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L197) ___ @@ -285,7 +285,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:189](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L189) +[lib/search/where-field.ts:189](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L189) ___ @@ -310,7 +310,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:205](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L205) +[lib/search/where-field.ts:205](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L205) ___ @@ -337,7 +337,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:20](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L20) +[lib/search/where-field.ts:20](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L20) ___ @@ -364,7 +364,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:30](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L30) +[lib/search/where-field.ts:30](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L30) ___ @@ -391,7 +391,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:50](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L50) +[lib/search/where-field.ts:50](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L50) ___ @@ -418,7 +418,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:40](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L40) +[lib/search/where-field.ts:40](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L40) ___ @@ -436,7 +436,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:111](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L111) +[lib/search/where-field.ts:111](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L111) ___ @@ -460,7 +460,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:125](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L125) +[lib/search/where-field.ts:125](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L125) ___ @@ -484,7 +484,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:139](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L139) +[lib/search/where-field.ts:139](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L139) ___ @@ -508,7 +508,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:118](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L118) +[lib/search/where-field.ts:118](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L118) ___ @@ -532,7 +532,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:132](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L132) +[lib/search/where-field.ts:132](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L132) ___ @@ -556,7 +556,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:212](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L212) +[lib/search/where-field.ts:212](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L212) ___ @@ -580,7 +580,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:219](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L219) +[lib/search/where-field.ts:219](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L219) ___ @@ -604,7 +604,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:153](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L153) +[lib/search/where-field.ts:153](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L153) ___ @@ -628,7 +628,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:167](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L167) +[lib/search/where-field.ts:167](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L167) ___ @@ -652,7 +652,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:146](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L146) +[lib/search/where-field.ts:146](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L146) ___ @@ -676,7 +676,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:160](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L160) +[lib/search/where-field.ts:160](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L160) ___ @@ -700,7 +700,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:57](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L57) +[lib/search/where-field.ts:57](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L57) ___ @@ -724,7 +724,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:71](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L71) +[lib/search/where-field.ts:71](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L71) ___ @@ -748,7 +748,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:78](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L78) +[lib/search/where-field.ts:78](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L78) ___ @@ -772,7 +772,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:64](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L64) +[lib/search/where-field.ts:64](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L64) ___ @@ -796,7 +796,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:85](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L85) +[lib/search/where-field.ts:85](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L85) ___ @@ -820,7 +820,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:226](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L226) +[lib/search/where-field.ts:226](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L226) ___ @@ -844,7 +844,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:254](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L254) +[lib/search/where-field.ts:254](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L254) ___ @@ -868,7 +868,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:247](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L247) +[lib/search/where-field.ts:247](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L247) ___ @@ -888,7 +888,7 @@ Converts this [Where](Where.md) into a portion of a RediSearch query. #### Defined in -[lib/search/where-field.ts:303](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L303) +[lib/search/where-field.ts:303](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L303) ___ @@ -906,4 +906,4 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:105](https://github.com/redis/redis-om-node/blob/e552415/lib/search/where-field.ts#L105) +[lib/search/where-field.ts:105](https://github.com/redis/redis-om-node/blob/5777b6c/lib/search/where-field.ts#L105)