From a66829872b1a46cc7d9872a5233f3c1e9b67ac44 Mon Sep 17 00:00:00 2001 From: Simon Green Date: Tue, 31 May 2022 14:10:47 -0600 Subject: [PATCH] Generated docs --- docs/README.md | 38 ++++--- docs/classes/AbstractSearch.md | 36 +++--- docs/classes/Circle.md | 30 ++--- docs/classes/Client.md | 14 +-- docs/classes/Entity.md | 6 +- docs/classes/RawSearch.md | 36 +++--- docs/classes/RedisError.md | 23 +--- docs/classes/Repository.md | 24 ++-- docs/classes/Schema.md | 35 ++++-- docs/classes/Search.md | 48 ++++---- docs/classes/Where.md | 2 +- docs/classes/WhereField.md | 74 ++++++------ docs/interfaces/BaseFieldDefinition.md | 18 ++- docs/interfaces/BooleanFieldDefinition.md | 24 +++- .../CaseSensitiveFieldDefinition.md | 32 ++++++ docs/interfaces/DateFieldDefinition.md | 24 +++- docs/interfaces/NormalizedFieldDefinition.md | 34 ++++++ docs/interfaces/NumberFieldDefinition.md | 24 +++- docs/interfaces/PhoneticFieldDefinition.md | 33 ++++++ docs/interfaces/PointFieldDefinition.md | 22 +++- docs/interfaces/SeparableFieldDefinition.md | 2 +- docs/interfaces/SortableFieldDefinition.md | 4 +- docs/interfaces/StemmingFieldDefinition.md | 30 +++++ docs/interfaces/StringArrayFieldDefinition.md | 83 +++++++++++++- docs/interfaces/StringFieldDefinition.md | 68 ++++++++++- docs/interfaces/TextFieldDefinition.md | 106 +++++++++++++++++- docs/interfaces/WeightFieldDefinition.md | 29 +++++ 27 files changed, 694 insertions(+), 205 deletions(-) create mode 100644 docs/interfaces/CaseSensitiveFieldDefinition.md create mode 100644 docs/interfaces/NormalizedFieldDefinition.md create mode 100644 docs/interfaces/PhoneticFieldDefinition.md create mode 100644 docs/interfaces/StemmingFieldDefinition.md create mode 100644 docs/interfaces/WeightFieldDefinition.md diff --git a/docs/README.md b/docs/README.md index 99b8901d..02b1cb12 100644 --- a/docs/README.md +++ b/docs/README.md @@ -22,16 +22,21 @@ redis-om - [BaseFieldDefinition](interfaces/BaseFieldDefinition.md) - [BooleanFieldDefinition](interfaces/BooleanFieldDefinition.md) +- [CaseSensitiveFieldDefinition](interfaces/CaseSensitiveFieldDefinition.md) - [DateFieldDefinition](interfaces/DateFieldDefinition.md) +- [NormalizedFieldDefinition](interfaces/NormalizedFieldDefinition.md) - [NumberFieldDefinition](interfaces/NumberFieldDefinition.md) +- [PhoneticFieldDefinition](interfaces/PhoneticFieldDefinition.md) - [PointFieldDefinition](interfaces/PointFieldDefinition.md) - [SeparableFieldDefinition](interfaces/SeparableFieldDefinition.md) - [SortableFieldDefinition](interfaces/SortableFieldDefinition.md) +- [StemmingFieldDefinition](interfaces/StemmingFieldDefinition.md) - [StringArrayFieldDefinition](interfaces/StringArrayFieldDefinition.md) - [StringFieldDefinition](interfaces/StringFieldDefinition.md) - [TextFieldDefinition](interfaces/TextFieldDefinition.md) +- [WeightFieldDefinition](interfaces/WeightFieldDefinition.md) -### Type Aliases +### Type aliases - [CircleFunction](README.md#circlefunction) - [DataStructure](README.md#datastructure) @@ -48,7 +53,7 @@ redis-om - [StopWordOptions](README.md#stopwordoptions) - [SubSearchFunction](README.md#subsearchfunction) -## Type Aliases +## Type aliases ### CircleFunction @@ -72,7 +77,7 @@ A function that defines a circle for `.inCircle` searches. #### Defined in -[lib/search/where-point.ts:9](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/where-point.ts#L9) +[lib/search/where-point.ts:9](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-point.ts#L9) ___ @@ -84,7 +89,7 @@ The type of data structure in Redis to map objects to. #### Defined in -[lib/schema/options/data-structure.ts:2](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/options/data-structure.ts#L2) +[lib/schema/options/data-structure.ts:2](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/options/data-structure.ts#L2) ___ @@ -114,7 +119,7 @@ A constructor that creates an [Entity](classes/Entity.md) of type TEntity. #### Defined in -[lib/entity/entity-constructor.ts:8](https://github.com/redis/redis-om-node/blob/9268f6d/lib/entity/entity-constructor.ts#L8) +[lib/entity/entity-constructor.ts:8](https://github.com/redis/redis-om-node/blob/48d362b/lib/entity/entity-constructor.ts#L8) ___ @@ -126,7 +131,7 @@ A JavaScript object containing the underlying data of an [Entity](classes/Entity #### Defined in -[lib/entity/entity-data.ts:6](https://github.com/redis/redis-om-node/blob/9268f6d/lib/entity/entity-data.ts#L6) +[lib/entity/entity-data.ts:6](https://github.com/redis/redis-om-node/blob/48d362b/lib/entity/entity-data.ts#L6) ___ @@ -138,7 +143,7 @@ Valid types for properties on an [Entity](classes/Entity.md). #### Defined in -[lib/entity/entity-value.ts:6](https://github.com/redis/redis-om-node/blob/9268f6d/lib/entity/entity-value.ts#L6) +[lib/entity/entity-value.ts:6](https://github.com/redis/redis-om-node/blob/48d362b/lib/entity/entity-value.ts#L6) ___ @@ -150,7 +155,7 @@ Contains instructions telling how to map a property on an [Entity](classes/Entit #### Defined in -[lib/schema/definition/field-definition.ts:10](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/field-definition.ts#L10) +[lib/schema/definition/field-definition.ts:10](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/field-definition.ts#L10) ___ @@ -170,7 +175,7 @@ A function that generates random [Entity IDs](classes/Entity.md#entityid). #### Defined in -[lib/schema/options/id-strategy.ts:2](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/options/id-strategy.ts#L2) +[lib/schema/options/id-strategy.ts:2](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/options/id-strategy.ts#L2) ___ @@ -189,7 +194,7 @@ Defines a point on the globe using longitude and latitude. #### Defined in -[lib/entity/point.ts:2](https://github.com/redis/redis-om-node/blob/9268f6d/lib/entity/point.ts#L2) +[lib/entity/point.ts:2](https://github.com/redis/redis-om-node/blob/48d362b/lib/entity/point.ts#L2) ___ @@ -201,7 +206,7 @@ Group of [FieldDefinition](README.md#fielddefinition)s that define the schema fo #### Defined in -[lib/schema/definition/schema-definition.ts:6](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/schema-definition.ts#L6) +[lib/schema/definition/schema-definition.ts:6](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/schema-definition.ts#L6) ___ @@ -213,7 +218,7 @@ Valid types a [FieldDefinition](README.md#fielddefinition). #### Defined in -[lib/schema/definition/schema-field-type.ts:4](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/schema-field-type.ts#L4) +[lib/schema/definition/schema-field-type.ts:4](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/schema-field-type.ts#L4) ___ @@ -231,13 +236,14 @@ Configuration options for a [Schema](classes/Schema.md). | `idStrategy?` | [`IdStrategy`](README.md#idstrategy) | A function that generates a random [Entity ID](classes/Entity.md#entityid). Defaults to a function that generates [ULIDs](https://github.com/ulid/spec). Combined with prefix to generate a Redis key. If prefix is `Foo` and idStratgey returns `12345` then the generated key would be `Foo:12345`. | | `indexHashName?` | `string` | The name used by Redis OM to store the hash of the index for this [Schema](classes/Schema.md). Defaults to prefix followed by `:index:hash`. So, for a prefix of `Foo`, it would use `Foo:index:hash`. | | `indexName?` | `string` | The name used by RediSearch to store the index for this [Schema](classes/Schema.md). Defaults to prefix followed by `:index`. So, for a prefix of `Foo`, it would use `Foo:index`. | +| `indexedDefault?` | `boolean` | Whether fields are indexed by default | | `prefix?` | `string` | The string that comes before the ID when creating Redis keys for [Entities](classes/Entity.md). Defaults to the class name of the [Entity](classes/Entity.md). Combined with the results of idStrategy to generate a key. If prefix is `Foo` and idStrategy returns `12345` then the generated key would be `Foo:12345`. | | `stopWords?` | `string`[] | Stop words to be used by this schema. If `useStopWords` is anything other than `CUSTOM`, this option is ignored. | | `useStopWords?` | [`StopWordOptions`](README.md#stopwordoptions) | Configures the usage of stop words. Valid values are `OFF`, `DEFAULT`, and `CUSTOM`. Setting this to `OFF` disables all stop words. Setting this to `DEFAULT` uses the stop words intrinsic to RediSearch. Setting this to `CUSTOM` tells RediSearch to use the stop words in `stopWords`. | #### Defined in -[lib/schema/options/schema-options.ts:9](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/options/schema-options.ts#L9) +[lib/schema/options/schema-options.ts:9](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/options/schema-options.ts#L9) ___ @@ -249,7 +255,7 @@ The type of data structure in Redis to map objects to. #### Defined in -[lib/client.ts:21](https://github.com/redis/redis-om-node/blob/9268f6d/lib/client.ts#L21) +[lib/client.ts:21](https://github.com/redis/redis-om-node/blob/48d362b/lib/client.ts#L21) ___ @@ -261,7 +267,7 @@ Valid values for how to use stop words for a given [Schema](classes/Schema.md). #### Defined in -[lib/schema/options/stop-word-options.ts:2](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/options/stop-word-options.ts#L2) +[lib/schema/options/stop-word-options.ts:2](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/options/stop-word-options.ts#L2) ___ @@ -293,4 +299,4 @@ A function that takes a [Search](classes/Search.md) and returns a [Search](class #### Defined in -[lib/search/search.ts:27](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L27) +[lib/search/search.ts:27](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L27) diff --git a/docs/classes/AbstractSearch.md b/docs/classes/AbstractSearch.md index 4301e9ad..c8baad32 100644 --- a/docs/classes/AbstractSearch.md +++ b/docs/classes/AbstractSearch.md @@ -61,7 +61,7 @@ this #### Defined in -[lib/search/search.ts:210](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L210) +[lib/search/search.ts:210](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L210) ## Methods @@ -93,7 +93,7 @@ An array of [Entities](Entity.md) matching the query. #### Defined in -[lib/search/search.ts:191](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L191) +[lib/search/search.ts:191](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L191) ___ @@ -109,7 +109,7 @@ Returns the number of [Entities](Entity.md) that match this query. #### Defined in -[lib/search/search.ts:149](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L149) +[lib/search/search.ts:149](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L149) ___ @@ -125,7 +125,7 @@ Returns only the first [Entity](Entity.md) that matches this query. #### Defined in -[lib/search/search.ts:172](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L172) +[lib/search/search.ts:172](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L172) ___ @@ -149,7 +149,7 @@ The [Entity](Entity.md) with the maximal value #### Defined in -[lib/search/search.ts:141](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L141) +[lib/search/search.ts:141](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L141) ___ @@ -173,7 +173,7 @@ The [Entity](Entity.md) with the minimal value #### Defined in -[lib/search/search.ts:132](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L132) +[lib/search/search.ts:132](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L132) ___ @@ -198,7 +198,7 @@ An array of [Entities](Entity.md) matching the query. #### Defined in -[lib/search/search.ts:162](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L162) +[lib/search/search.ts:162](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L162) ___ @@ -221,7 +221,7 @@ Alias for [Search.all](Search.md#all). #### Defined in -[lib/search/search.ts:245](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L245) +[lib/search/search.ts:245](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L245) ___ @@ -237,7 +237,7 @@ Alias for [Search.count](Search.md#count). #### Defined in -[lib/search/search.ts:231](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L231) +[lib/search/search.ts:231](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L231) ___ @@ -253,7 +253,7 @@ Alias for [Search.first](Search.md#first). #### Defined in -[lib/search/search.ts:252](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L252) +[lib/search/search.ts:252](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L252) ___ @@ -275,7 +275,7 @@ Alias for [Search.max](Search.md#max). #### Defined in -[lib/search/search.ts:224](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L224) +[lib/search/search.ts:224](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L224) ___ @@ -297,7 +297,7 @@ Alias for [Search.min](Search.md#min). #### Defined in -[lib/search/search.ts:217](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L217) +[lib/search/search.ts:217](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L217) ___ @@ -320,7 +320,7 @@ Alias for [Search.page](Search.md#page). #### Defined in -[lib/search/search.ts:238](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L238) +[lib/search/search.ts:238](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L238) ___ @@ -342,7 +342,7 @@ Alias for [Search.sortAscending](Search.md#sortascending). #### Defined in -[lib/search/search.ts:84](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L84) +[lib/search/search.ts:84](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L84) ___ @@ -366,7 +366,7 @@ this #### Defined in -[lib/search/search.ts:61](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L61) +[lib/search/search.ts:61](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L61) ___ @@ -391,7 +391,7 @@ this #### Defined in -[lib/search/search.ts:94](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L94) +[lib/search/search.ts:94](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L94) ___ @@ -413,7 +413,7 @@ Alias for [Search.sortDescending](Search.md#sortdescending). #### Defined in -[lib/search/search.ts:68](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L68) +[lib/search/search.ts:68](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L68) ___ @@ -437,4 +437,4 @@ this #### Defined in -[lib/search/search.ts:77](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L77) +[lib/search/search.ts:77](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L77) diff --git a/docs/classes/Circle.md b/docs/classes/Circle.md index 3927c93a..e3bc972c 100644 --- a/docs/classes/Circle.md +++ b/docs/classes/Circle.md @@ -53,7 +53,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:150](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/where-point.ts#L150) +[lib/search/where-point.ts:150](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-point.ts#L150) ___ @@ -71,7 +71,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:144](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/where-point.ts#L144) +[lib/search/where-point.ts:144](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-point.ts#L144) ___ @@ -89,7 +89,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:138](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/where-point.ts#L138) +[lib/search/where-point.ts:138](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-point.ts#L138) ___ @@ -107,7 +107,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:123](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/where-point.ts#L123) +[lib/search/where-point.ts:123](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-point.ts#L123) ___ @@ -125,7 +125,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:129](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/where-point.ts#L129) +[lib/search/where-point.ts:129](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-point.ts#L129) ___ @@ -143,7 +143,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:117](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/where-point.ts#L117) +[lib/search/where-point.ts:117](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-point.ts#L117) ___ @@ -161,7 +161,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:96](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/where-point.ts#L96) +[lib/search/where-point.ts:96](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-point.ts#L96) ___ @@ -179,7 +179,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:102](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/where-point.ts#L102) +[lib/search/where-point.ts:102](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-point.ts#L102) ___ @@ -197,7 +197,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:108](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/where-point.ts#L108) +[lib/search/where-point.ts:108](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-point.ts#L108) ___ @@ -215,7 +215,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:159](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/where-point.ts#L159) +[lib/search/where-point.ts:159](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-point.ts#L159) ___ @@ -233,7 +233,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:165](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/where-point.ts#L165) +[lib/search/where-point.ts:165](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-point.ts#L165) ___ @@ -251,7 +251,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:171](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/where-point.ts#L171) +[lib/search/where-point.ts:171](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-point.ts#L171) ## Methods @@ -275,7 +275,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:43](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/where-point.ts#L43) +[lib/search/where-point.ts:43](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-point.ts#L43) ___ @@ -299,7 +299,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:32](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/where-point.ts#L32) +[lib/search/where-point.ts:32](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-point.ts#L32) ___ @@ -324,4 +324,4 @@ This instance. #### Defined in -[lib/search/where-point.ts:87](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/where-point.ts#L87) +[lib/search/where-point.ts:87](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-point.ts#L87) diff --git a/docs/classes/Client.md b/docs/classes/Client.md index a557bca8..a3a6f11f 100644 --- a/docs/classes/Client.md +++ b/docs/classes/Client.md @@ -49,7 +49,7 @@ Close the connection to Redis. #### Defined in -[lib/client.ts:127](https://github.com/redis/redis-om-node/blob/9268f6d/lib/client.ts#L127) +[lib/client.ts:127](https://github.com/redis/redis-om-node/blob/48d362b/lib/client.ts#L127) ___ @@ -73,7 +73,7 @@ The raw results of calling the Redis command. #### Defined in -[lib/client.ts:100](https://github.com/redis/redis-om-node/blob/9268f6d/lib/client.ts#L100) +[lib/client.ts:100](https://github.com/redis/redis-om-node/blob/48d362b/lib/client.ts#L100) ___ @@ -103,7 +103,7 @@ A repository for the provided schema. #### Defined in -[lib/client.ts:115](https://github.com/redis/redis-om-node/blob/9268f6d/lib/client.ts#L115) +[lib/client.ts:115](https://github.com/redis/redis-om-node/blob/48d362b/lib/client.ts#L115) ___ @@ -119,7 +119,7 @@ Whether a connection is already open. #### Defined in -[lib/client.ts:225](https://github.com/redis/redis-om-node/blob/9268f6d/lib/client.ts#L225) +[lib/client.ts:225](https://github.com/redis/redis-om-node/blob/48d362b/lib/client.ts#L225) ___ @@ -143,7 +143,7 @@ This [Client](Client.md) instance. #### Defined in -[lib/client.ts:86](https://github.com/redis/redis-om-node/blob/9268f6d/lib/client.ts#L86) +[lib/client.ts:86](https://github.com/redis/redis-om-node/blob/48d362b/lib/client.ts#L86) ___ @@ -158,7 +158,7 @@ any existing connection. | Name | Type | Description | | :------ | :------ | :------ | -| `connection` | `RedisClientType`<{ `bf`: { `ADD`: `__module` ; `EXISTS`: `__module` ; `INFO`: `__module` ; `INSERT`: `__module` ; `LOADCHUNK`: `__module` ; `MADD`: `__module` ; `MEXISTS`: `__module` ; `RESERVE`: `__module` ; `SCANDUMP`: `__module` ; `add`: `__module` ; `exists`: `__module` ; `info`: `__module` ; `insert`: `__module` ; `loadChunk`: `__module` ; `mAdd`: `__module` ; `mExists`: `__module` ; `reserve`: `__module` ; `scanDump`: `__module` } ; `cf`: { `ADD`: `__module` ; `ADDNX`: `__module` ; `COUNT`: `__module` ; `DEL`: `__module` ; `EXISTS`: `__module` ; `INFO`: `__module` ; `INSERT`: `__module` ; `INSERTNX`: `__module` ; `LOADCHUNK`: `__module` ; `RESERVE`: `__module` ; `SCANDUMP`: `__module` ; `add`: `__module` ; `addNX`: `__module` ; `count`: `__module` ; `del`: `__module` ; `exists`: `__module` ; `info`: `__module` ; `insert`: `__module` ; `insertNX`: `__module` ; `loadChunk`: `__module` ; `reserve`: `__module` ; `scanDump`: `__module` } ; `cms`: { `INCRBY`: `__module` ; `INFO`: `__module` ; `INITBYDIM`: `__module` ; `INITBYPROB`: `__module` ; `MERGE`: `__module` ; `QUERY`: `__module` ; `incrBy`: `__module` ; `info`: `__module` ; `initByDim`: `__module` ; `initByProb`: `__module` ; `merge`: `__module` ; `query`: `__module` } ; `ft`: { `AGGREGATE`: `__module` ; `ALIASADD`: `__module` ; `ALIASDEL`: `__module` ; `ALIASUPDATE`: `__module` ; `ALTER`: `__module` ; `CONFIG_GET`: `__module` ; `CONFIG_SET`: `__module` ; `CREATE`: `__module` ; `DICTADD`: `__module` ; `DICTDEL`: `__module` ; `DICTDUMP`: `__module` ; `DROPINDEX`: `__module` ; `EXPLAIN`: `__module` ; `EXPLAINCLI`: `__module` ; `INFO`: `__module` ; `PROFILEAGGREGATE`: `__module` ; `PROFILESEARCH`: `__module` ; `SEARCH`: `__module` ; `SPELLCHECK`: `__module` ; `SUGADD`: `__module` ; `SUGDEL`: `__module` ; `SUGGET`: `__module` ; `SUGGET_WITHPAYLOADS`: `__module` ; `SUGGET_WITHSCORES`: `__module` ; `SUGGET_WITHSCORES_WITHPAYLOADS`: `__module` ; `SUGLEN`: `__module` ; `SYNDUMP`: `__module` ; `SYNUPDATE`: `__module` ; `TAGVALS`: `__module` ; `_LIST`: `__module` ; `_list`: `__module` ; `aggregate`: `__module` ; `aliasAdd`: `__module` ; `aliasDel`: `__module` ; `aliasUpdate`: `__module` ; `alter`: `__module` ; `configGet`: `__module` ; `configSet`: `__module` ; `create`: `__module` ; `dictAdd`: `__module` ; `dictDel`: `__module` ; `dictDump`: `__module` ; `dropIndex`: `__module` ; `explain`: `__module` ; `explainCli`: `__module` ; `info`: `__module` ; `profileAggregate`: `__module` ; `profileSearch`: `__module` ; `search`: `__module` ; `spellCheck`: `__module` ; `sugAdd`: `__module` ; `sugDel`: `__module` ; `sugGet`: `__module` ; `sugGetWithPayloads`: `__module` ; `sugGetWithScores`: `__module` ; `sugGetWithScoresWithPayloads`: `__module` ; `sugLen`: `__module` ; `synDump`: `__module` ; `synUpdate`: `__module` ; `tagVals`: `__module` } ; `graph`: { `CONFIG_GET`: `__module` ; `CONFIG_SET`: `__module` ; `DELETE`: `__module` ; `EXPLAIN`: `__module` ; `LIST`: `__module` ; `PROFILE`: `__module` ; `QUERY`: `__module` ; `QUERY_RO`: `__module` ; `SLOWLOG`: `__module` ; `configGet`: `__module` ; `configSet`: `__module` ; `delete`: `__module` ; `explain`: `__module` ; `list`: `__module` ; `profile`: `__module` ; `query`: `__module` ; `queryRo`: `__module` ; `slowLog`: `__module` } ; `json`: { `ARRAPPEND`: `__module` ; `ARRINDEX`: `__module` ; `ARRINSERT`: `__module` ; `ARRLEN`: `__module` ; `ARRPOP`: `__module` ; `ARRTRIM`: `__module` ; `DEBUG_MEMORY`: `__module` ; `DEL`: `__module` ; `FORGET`: `__module` ; `GET`: `__module` ; `MGET`: `__module` ; `NUMINCRBY`: `__module` ; `NUMMULTBY`: `__module` ; `OBJKEYS`: `__module` ; `OBJLEN`: `__module` ; `RESP`: `__module` ; `SET`: `__module` ; `STRAPPEND`: `__module` ; `STRLEN`: `__module` ; `TYPE`: `__module` ; `arrAppend`: `__module` ; `arrIndex`: `__module` ; `arrInsert`: `__module` ; `arrLen`: `__module` ; `arrPop`: `__module` ; `arrTrim`: `__module` ; `debugMemory`: `__module` ; `del`: `__module` ; `forget`: `__module` ; `get`: `__module` ; `mGet`: `__module` ; `numIncrBy`: `__module` ; `numMultBy`: `__module` ; `objKeys`: `__module` ; `objLen`: `__module` ; `resp`: `__module` ; `set`: `__module` ; `strAppend`: `__module` ; `strLen`: `__module` ; `type`: `__module` } ; `topK`: { `ADD`: `__module` ; `COUNT`: `__module` ; `INCRBY`: `__module` ; `INFO`: `__module` ; `LIST`: `__module` ; `LIST_WITHCOUNT`: `__module` ; `QUERY`: `__module` ; `RESERVE`: `__module` ; `add`: `__module` ; `count`: `__module` ; `incrBy`: `__module` ; `info`: `__module` ; `list`: `__module` ; `listWithCount`: `__module` ; `query`: `__module` ; `reserve`: `__module` } ; `ts`: { `ADD`: `__module` ; `ALTER`: `__module` ; `CREATE`: `__module` ; `CREATERULE`: `__module` ; `DECRBY`: `__module` ; `DEL`: `__module` ; `DELETERULE`: `__module` ; `GET`: `__module` ; `INCRBY`: `__module` ; `INFO`: `__module` ; `INFO_DEBUG`: `__module` ; `MADD`: `__module` ; `MGET`: `__module` ; `MGET_WITHLABELS`: `__module` ; `MRANGE`: `__module` ; `MRANGE_WITHLABELS`: `__module` ; `MREVRANGE`: `__module` ; `MREVRANGE_WITHLABELS`: `__module` ; `QUERYINDEX`: `__module` ; `RANGE`: `__module` ; `REVRANGE`: `__module` ; `add`: `__module` ; `alter`: `__module` ; `create`: `__module` ; `createRule`: `__module` ; `decrBy`: `__module` ; `del`: `__module` ; `deleteRule`: `__module` ; `get`: `__module` ; `incrBy`: `__module` ; `info`: `__module` ; `infoDebug`: `__module` ; `mAdd`: `__module` ; `mGet`: `__module` ; `mGetWithLabels`: `__module` ; `mRange`: `__module` ; `mRangeWithLabels`: `__module` ; `mRevRange`: `__module` ; `mRevRangeWithLabels`: `__module` ; `queryIndex`: `__module` ; `range`: `__module` ; `revRange`: `__module` } } & `RedisModules`, `RedisFunctions`, `RedisScripts`\> | An existing Node Redis client. | +| `connection` | `RedisClientType`<{ `bf`: { `ADD`: `__module` ; `EXISTS`: `__module` ; `INFO`: `__module` ; `INSERT`: `__module` ; `LOADCHUNK`: `__module` ; `MADD`: `__module` ; `MEXISTS`: `__module` ; `RESERVE`: `__module` ; `SCANDUMP`: `__module` ; `add`: `__module` ; `exists`: `__module` ; `info`: `__module` ; `insert`: `__module` ; `loadChunk`: `__module` ; `mAdd`: `__module` ; `mExists`: `__module` ; `reserve`: `__module` ; `scanDump`: `__module` } ; `cf`: { `ADD`: `__module` ; `ADDNX`: `__module` ; `COUNT`: `__module` ; `DEL`: `__module` ; `EXISTS`: `__module` ; `INFO`: `__module` ; `INSERT`: `__module` ; `INSERTNX`: `__module` ; `LOADCHUNK`: `__module` ; `RESERVE`: `__module` ; `SCANDUMP`: `__module` ; `add`: `__module` ; `addNX`: `__module` ; `count`: `__module` ; `del`: `__module` ; `exists`: `__module` ; `info`: `__module` ; `insert`: `__module` ; `insertNX`: `__module` ; `loadChunk`: `__module` ; `reserve`: `__module` ; `scanDump`: `__module` } ; `cms`: { `INCRBY`: `__module` ; `INFO`: `__module` ; `INITBYDIM`: `__module` ; `INITBYPROB`: `__module` ; `MERGE`: `__module` ; `QUERY`: `__module` ; `incrBy`: `__module` ; `info`: `__module` ; `initByDim`: `__module` ; `initByProb`: `__module` ; `merge`: `__module` ; `query`: `__module` } ; `ft`: { `AGGREGATE`: `__module` ; `ALIASADD`: `__module` ; `ALIASDEL`: `__module` ; `ALIASUPDATE`: `__module` ; `ALTER`: `__module` ; `CONFIG_GET`: `__module` ; `CONFIG_SET`: `__module` ; `CREATE`: `__module` ; `DICTADD`: `__module` ; `DICTDEL`: `__module` ; `DICTDUMP`: `__module` ; `DROPINDEX`: `__module` ; `EXPLAIN`: `__module` ; `EXPLAINCLI`: `__module` ; `INFO`: `__module` ; `PROFILEAGGREGATE`: `__module` ; `PROFILESEARCH`: `__module` ; `SEARCH`: `__module` ; `SPELLCHECK`: `__module` ; `SUGADD`: `__module` ; `SUGDEL`: `__module` ; `SUGGET`: `__module` ; `SUGGET_WITHPAYLOADS`: `__module` ; `SUGGET_WITHSCORES`: `__module` ; `SUGGET_WITHSCORES_WITHPAYLOADS`: `__module` ; `SUGLEN`: `__module` ; `SYNDUMP`: `__module` ; `SYNUPDATE`: `__module` ; `TAGVALS`: `__module` ; `_LIST`: `__module` ; `_list`: `__module` ; `aggregate`: `__module` ; `aliasAdd`: `__module` ; `aliasDel`: `__module` ; `aliasUpdate`: `__module` ; `alter`: `__module` ; `configGet`: `__module` ; `configSet`: `__module` ; `create`: `__module` ; `dictAdd`: `__module` ; `dictDel`: `__module` ; `dictDump`: `__module` ; `dropIndex`: `__module` ; `explain`: `__module` ; `explainCli`: `__module` ; `info`: `__module` ; `profileAggregate`: `__module` ; `profileSearch`: `__module` ; `search`: `__module` ; `spellCheck`: `__module` ; `sugAdd`: `__module` ; `sugDel`: `__module` ; `sugGet`: `__module` ; `sugGetWithPayloads`: `__module` ; `sugGetWithScores`: `__module` ; `sugGetWithScoresWithPayloads`: `__module` ; `sugLen`: `__module` ; `synDump`: `__module` ; `synUpdate`: `__module` ; `tagVals`: `__module` } ; `graph`: { `CONFIG_GET`: `__module` ; `CONFIG_SET`: `__module` ; `DELETE`: `__module` ; `EXPLAIN`: `__module` ; `LIST`: `__module` ; `PROFILE`: `__module` ; `QUERY`: `__module` ; `QUERY_RO`: `__module` ; `SLOWLOG`: `__module` ; `configGet`: `__module` ; `configSet`: `__module` ; `delete`: `__module` ; `explain`: `__module` ; `list`: `__module` ; `profile`: `__module` ; `query`: `__module` ; `queryRo`: `__module` ; `slowLog`: `__module` } ; `json`: { `ARRAPPEND`: `__module` ; `ARRINDEX`: `__module` ; `ARRINSERT`: `__module` ; `ARRLEN`: `__module` ; `ARRPOP`: `__module` ; `ARRTRIM`: `__module` ; `DEBUG_MEMORY`: `__module` ; `DEL`: `__module` ; `FORGET`: `__module` ; `GET`: `__module` ; `MGET`: `__module` ; `NUMINCRBY`: `__module` ; `NUMMULTBY`: `__module` ; `OBJKEYS`: `__module` ; `OBJLEN`: `__module` ; `RESP`: `__module` ; `SET`: `__module` ; `STRAPPEND`: `__module` ; `STRLEN`: `__module` ; `TYPE`: `__module` ; `arrAppend`: `__module` ; `arrIndex`: `__module` ; `arrInsert`: `__module` ; `arrLen`: `__module` ; `arrPop`: `__module` ; `arrTrim`: `__module` ; `debugMemory`: `__module` ; `del`: `__module` ; `forget`: `__module` ; `get`: `__module` ; `mGet`: `__module` ; `numIncrBy`: `__module` ; `numMultBy`: `__module` ; `objKeys`: `__module` ; `objLen`: `__module` ; `resp`: `__module` ; `set`: `__module` ; `strAppend`: `__module` ; `strLen`: `__module` ; `type`: `__module` } ; `topK`: { `ADD`: `__module` ; `COUNT`: `__module` ; `INCRBY`: `__module` ; `INFO`: `__module` ; `LIST`: `__module` ; `QUERY`: `__module` ; `RESERVE`: `__module` ; `add`: `__module` ; `count`: `__module` ; `incrBy`: `__module` ; `info`: `__module` ; `list`: `__module` ; `query`: `__module` ; `reserve`: `__module` } ; `ts`: { `ADD`: `__module` ; `ALTER`: `__module` ; `CREATE`: `__module` ; `CREATERULE`: `__module` ; `DECRBY`: `__module` ; `DEL`: `__module` ; `DELETERULE`: `__module` ; `GET`: `__module` ; `INCRBY`: `__module` ; `INFO`: `__module` ; `INFO_DEBUG`: `__module` ; `MADD`: `__module` ; `MGET`: `__module` ; `MGET_WITHLABELS`: `__module` ; `MRANGE`: `__module` ; `MRANGE_WITHLABELS`: `__module` ; `MREVRANGE`: `__module` ; `MREVRANGE_WITHLABELS`: `__module` ; `QUERYINDEX`: `__module` ; `RANGE`: `__module` ; `REVRANGE`: `__module` ; `add`: `__module` ; `alter`: `__module` ; `create`: `__module` ; `createRule`: `__module` ; `decrBy`: `__module` ; `del`: `__module` ; `deleteRule`: `__module` ; `get`: `__module` ; `incrBy`: `__module` ; `info`: `__module` ; `infoDebug`: `__module` ; `mAdd`: `__module` ; `mGet`: `__module` ; `mGetWithLabels`: `__module` ; `mRange`: `__module` ; `mRangeWithLabels`: `__module` ; `mRevRange`: `__module` ; `mRevRangeWithLabels`: `__module` ; `queryIndex`: `__module` ; `range`: `__module` ; `revRange`: `__module` } } & `RedisModules`, `RedisScripts`\> | An existing Node Redis client. | #### Returns @@ -168,4 +168,4 @@ This [Client](Client.md) instance. #### Defined in -[lib/client.ts:75](https://github.com/redis/redis-om-node/blob/9268f6d/lib/client.ts#L75) +[lib/client.ts:75](https://github.com/redis/redis-om-node/blob/48d362b/lib/client.ts#L75) diff --git a/docs/classes/Entity.md b/docs/classes/Entity.md index 6670c4c3..332d1126 100644 --- a/docs/classes/Entity.md +++ b/docs/classes/Entity.md @@ -33,7 +33,7 @@ The generated entity ID. #### Defined in -[lib/entity/entity.ts:38](https://github.com/redis/redis-om-node/blob/9268f6d/lib/entity/entity.ts#L38) +[lib/entity/entity.ts:38](https://github.com/redis/redis-om-node/blob/48d362b/lib/entity/entity.ts#L38) ## Accessors @@ -49,7 +49,7 @@ The keyname this [Entity](Entity.md) is stored with in Redis. #### Defined in -[lib/entity/entity.ts:74](https://github.com/redis/redis-om-node/blob/9268f6d/lib/entity/entity.ts#L74) +[lib/entity/entity.ts:74](https://github.com/redis/redis-om-node/blob/48d362b/lib/entity/entity.ts#L74) ## Methods @@ -67,4 +67,4 @@ a JavaScript object. #### Defined in -[lib/entity/entity.ts:82](https://github.com/redis/redis-om-node/blob/9268f6d/lib/entity/entity.ts#L82) +[lib/entity/entity.ts:82](https://github.com/redis/redis-om-node/blob/48d362b/lib/entity/entity.ts#L82) diff --git a/docs/classes/RawSearch.md b/docs/classes/RawSearch.md index a1021b2b..2c189c11 100644 --- a/docs/classes/RawSearch.md +++ b/docs/classes/RawSearch.md @@ -64,7 +64,7 @@ AbstractSearch.return #### Defined in -[lib/search/search.ts:210](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L210) +[lib/search/search.ts:210](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L210) ## Methods @@ -100,7 +100,7 @@ An array of [Entities](Entity.md) matching the query. #### Defined in -[lib/search/search.ts:191](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L191) +[lib/search/search.ts:191](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L191) ___ @@ -120,7 +120,7 @@ Returns the number of [Entities](Entity.md) that match this query. #### Defined in -[lib/search/search.ts:149](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L149) +[lib/search/search.ts:149](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L149) ___ @@ -140,7 +140,7 @@ Returns only the first [Entity](Entity.md) that matches this query. #### Defined in -[lib/search/search.ts:172](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L172) +[lib/search/search.ts:172](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L172) ___ @@ -168,7 +168,7 @@ The [Entity](Entity.md) with the maximal value #### Defined in -[lib/search/search.ts:141](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L141) +[lib/search/search.ts:141](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L141) ___ @@ -196,7 +196,7 @@ The [Entity](Entity.md) with the minimal value #### Defined in -[lib/search/search.ts:132](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L132) +[lib/search/search.ts:132](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L132) ___ @@ -225,7 +225,7 @@ An array of [Entities](Entity.md) matching the query. #### Defined in -[lib/search/search.ts:162](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L162) +[lib/search/search.ts:162](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L162) ___ @@ -252,7 +252,7 @@ Alias for [Search.all](Search.md#all). #### Defined in -[lib/search/search.ts:245](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L245) +[lib/search/search.ts:245](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L245) ___ @@ -272,7 +272,7 @@ Alias for [Search.count](Search.md#count). #### Defined in -[lib/search/search.ts:231](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L231) +[lib/search/search.ts:231](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L231) ___ @@ -292,7 +292,7 @@ Alias for [Search.first](Search.md#first). #### Defined in -[lib/search/search.ts:252](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L252) +[lib/search/search.ts:252](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L252) ___ @@ -318,7 +318,7 @@ Alias for [Search.max](Search.md#max). #### Defined in -[lib/search/search.ts:224](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L224) +[lib/search/search.ts:224](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L224) ___ @@ -344,7 +344,7 @@ Alias for [Search.min](Search.md#min). #### Defined in -[lib/search/search.ts:217](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L217) +[lib/search/search.ts:217](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L217) ___ @@ -371,7 +371,7 @@ Alias for [Search.page](Search.md#page). #### Defined in -[lib/search/search.ts:238](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L238) +[lib/search/search.ts:238](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L238) ___ @@ -397,7 +397,7 @@ Alias for [Search.sortAscending](Search.md#sortascending). #### Defined in -[lib/search/search.ts:84](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L84) +[lib/search/search.ts:84](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L84) ___ @@ -425,7 +425,7 @@ this #### Defined in -[lib/search/search.ts:61](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L61) +[lib/search/search.ts:61](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L61) ___ @@ -454,7 +454,7 @@ this #### Defined in -[lib/search/search.ts:94](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L94) +[lib/search/search.ts:94](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L94) ___ @@ -480,7 +480,7 @@ Alias for [Search.sortDescending](Search.md#sortdescending). #### Defined in -[lib/search/search.ts:68](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L68) +[lib/search/search.ts:68](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L68) ___ @@ -508,4 +508,4 @@ this #### Defined in -[lib/search/search.ts:77](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L77) +[lib/search/search.ts:77](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L77) diff --git a/docs/classes/RedisError.md b/docs/classes/RedisError.md index 02c88f9b..45495a73 100644 --- a/docs/classes/RedisError.md +++ b/docs/classes/RedisError.md @@ -16,7 +16,6 @@ ### Properties -- [cause](RedisError.md#cause) - [message](RedisError.md#message) - [name](RedisError.md#name) - [stack](RedisError.md#stack) @@ -45,24 +44,10 @@ Error.constructor #### Defined in -[lib/errors.ts:2](https://github.com/redis/redis-om-node/blob/9268f6d/lib/errors.ts#L2) +[lib/errors.ts:2](https://github.com/redis/redis-om-node/blob/48d362b/lib/errors.ts#L2) ## Properties -### cause - -• `Optional` **cause**: `Error` - -#### Inherited from - -Error.cause - -#### Defined in - -node_modules/typescript/lib/lib.es2022.error.d.ts:26 - -___ - ### message • **message**: `string` @@ -73,7 +58,7 @@ Error.message #### Defined in -node_modules/typescript/lib/lib.es5.d.ts:1029 +node_modules/typescript/lib/lib.es5.d.ts:1023 ___ @@ -87,7 +72,7 @@ Error.name #### Defined in -node_modules/typescript/lib/lib.es5.d.ts:1028 +node_modules/typescript/lib/lib.es5.d.ts:1022 ___ @@ -101,7 +86,7 @@ Error.stack #### Defined in -node_modules/typescript/lib/lib.es5.d.ts:1030 +node_modules/typescript/lib/lib.es5.d.ts:1024 ___ diff --git a/docs/classes/Repository.md b/docs/classes/Repository.md index 72eb63b3..dc3e0c36 100644 --- a/docs/classes/Repository.md +++ b/docs/classes/Repository.md @@ -71,7 +71,7 @@ const entities = await repository.search() #### Defined in -[lib/repository/repository.ts:49](https://github.com/redis/redis-om-node/blob/9268f6d/lib/repository/repository.ts#L49) +[lib/repository/repository.ts:49](https://github.com/redis/redis-om-node/blob/48d362b/lib/repository/repository.ts#L49) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -[lib/repository/repository.ts:50](https://github.com/redis/redis-om-node/blob/9268f6d/lib/repository/repository.ts#L50) +[lib/repository/repository.ts:50](https://github.com/redis/redis-om-node/blob/48d362b/lib/repository/repository.ts#L50) ## Methods @@ -106,7 +106,7 @@ The newly created and saved Entity. #### Defined in -[lib/repository/repository.ts:130](https://github.com/redis/redis-om-node/blob/9268f6d/lib/repository/repository.ts#L130) +[lib/repository/repository.ts:130](https://github.com/redis/redis-om-node/blob/48d362b/lib/repository/repository.ts#L130) ___ @@ -130,7 +130,7 @@ A newly created Entity. #### Defined in -[lib/repository/repository.ts:108](https://github.com/redis/redis-om-node/blob/9268f6d/lib/repository/repository.ts#L108) +[lib/repository/repository.ts:108](https://github.com/redis/redis-om-node/blob/48d362b/lib/repository/repository.ts#L108) ___ @@ -147,7 +147,7 @@ that RediSearch or RedisJSON is installed on your instance of Redis. #### Defined in -[lib/repository/repository.ts:62](https://github.com/redis/redis-om-node/blob/9268f6d/lib/repository/repository.ts#L62) +[lib/repository/repository.ts:62](https://github.com/redis/redis-om-node/blob/48d362b/lib/repository/repository.ts#L62) ___ @@ -165,7 +165,7 @@ on your instance of Redis. #### Defined in -[lib/repository/repository.ts:90](https://github.com/redis/redis-om-node/blob/9268f6d/lib/repository/repository.ts#L90) +[lib/repository/repository.ts:90](https://github.com/redis/redis-om-node/blob/48d362b/lib/repository/repository.ts#L90) ___ @@ -189,7 +189,7 @@ found, does nothing. #### Defined in -[lib/repository/repository.ts:163](https://github.com/redis/redis-om-node/blob/9268f6d/lib/repository/repository.ts#L163) +[lib/repository/repository.ts:163](https://github.com/redis/redis-om-node/blob/48d362b/lib/repository/repository.ts#L163) ___ @@ -215,7 +215,7 @@ The matching Entity. #### Defined in -[lib/repository/repository.ts:143](https://github.com/redis/redis-om-node/blob/9268f6d/lib/repository/repository.ts#L143) +[lib/repository/repository.ts:143](https://github.com/redis/redis-om-node/blob/48d362b/lib/repository/repository.ts#L143) ___ @@ -238,7 +238,7 @@ not found, does nothing. #### Defined in -[lib/repository/repository.ts:152](https://github.com/redis/redis-om-node/blob/9268f6d/lib/repository/repository.ts#L152) +[lib/repository/repository.ts:152](https://github.com/redis/redis-om-node/blob/48d362b/lib/repository/repository.ts#L152) ___ @@ -263,7 +263,7 @@ The ID of the Entity just saved. #### Defined in -[lib/repository/repository.ts:119](https://github.com/redis/redis-om-node/blob/9268f6d/lib/repository/repository.ts#L119) +[lib/repository/repository.ts:119](https://github.com/redis/redis-om-node/blob/48d362b/lib/repository/repository.ts#L119) ___ @@ -282,7 +282,7 @@ A [Search](Search.md) object. #### Defined in -[lib/repository/repository.ts:174](https://github.com/redis/redis-om-node/blob/9268f6d/lib/repository/repository.ts#L174) +[lib/repository/repository.ts:174](https://github.com/redis/redis-om-node/blob/48d362b/lib/repository/repository.ts#L174) ___ @@ -310,4 +310,4 @@ A [RawSearch](RawSearch.md) object. #### Defined in -[lib/repository/repository.ts:186](https://github.com/redis/redis-om-node/blob/9268f6d/lib/repository/repository.ts#L186) +[lib/repository/repository.ts:186](https://github.com/redis/redis-om-node/blob/48d362b/lib/repository/repository.ts#L186) diff --git a/docs/classes/Schema.md b/docs/classes/Schema.md index 6d938aa1..0d98f6d6 100644 --- a/docs/classes/Schema.md +++ b/docs/classes/Schema.md @@ -41,6 +41,7 @@ its constructor. - [indexHash](Schema.md#indexhash) - [indexHashName](Schema.md#indexhashname) - [indexName](Schema.md#indexname) +- [indexedDefault](Schema.md#indexeddefault) - [prefix](Schema.md#prefix) - [stopWords](Schema.md#stopwords) - [useStopWords](Schema.md#usestopwords) @@ -71,7 +72,7 @@ its constructor. #### Defined in -[lib/schema/schema.ts:62](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/schema.ts#L62) +[lib/schema/schema.ts:62](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/schema.ts#L62) ## Accessors @@ -88,7 +89,7 @@ that this Schema uses to store [Entities](Entity.md) in Redis. #### Defined in -[lib/schema/schema.ts:84](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/schema.ts#L84) +[lib/schema/schema.ts:84](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/schema.ts#L84) ___ @@ -104,7 +105,7 @@ The hash value of this index. Stored in Redis under [Schema.indexHashName](Schem #### Defined in -[lib/schema/schema.ts:100](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/schema.ts#L100) +[lib/schema/schema.ts:105](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/schema.ts#L105) ___ @@ -120,7 +121,7 @@ The configured name for the RediSearch index hash for this Schema. #### Defined in -[lib/schema/schema.ts:78](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/schema.ts#L78) +[lib/schema/schema.ts:78](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/schema.ts#L78) ___ @@ -136,7 +137,23 @@ The configured name for the RediSearch index for this Schema. #### Defined in -[lib/schema/schema.ts:75](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/schema.ts#L75) +[lib/schema/schema.ts:75](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/schema.ts#L75) + +___ + +### indexedDefault + +• `get` **indexedDefault**(): `boolean` + +The configured indexed default setting for fields + +#### Returns + +`boolean` + +#### Defined in + +[lib/schema/schema.ts:102](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/schema.ts#L102) ___ @@ -152,7 +169,7 @@ The configured keyspace prefix in Redis for this Schema. #### Defined in -[lib/schema/schema.ts:72](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/schema.ts#L72) +[lib/schema/schema.ts:72](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/schema.ts#L72) ___ @@ -169,7 +186,7 @@ than `CUSTOM`. #### Defined in -[lib/schema/schema.ts:97](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/schema.ts#L97) +[lib/schema/schema.ts:97](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/schema.ts#L97) ___ @@ -187,7 +204,7 @@ for more details. #### Defined in -[lib/schema/schema.ts:91](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/schema.ts#L91) +[lib/schema/schema.ts:91](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/schema.ts#L91) ## Methods @@ -203,4 +220,4 @@ Generates a unique string using the configured [IdStrategy](../README.md#idstrat #### Defined in -[lib/schema/schema.ts:126](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/schema.ts#L126) +[lib/schema/schema.ts:131](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/schema.ts#L131) diff --git a/docs/classes/Search.md b/docs/classes/Search.md index 6a8f92f5..8c501a9d 100644 --- a/docs/classes/Search.md +++ b/docs/classes/Search.md @@ -66,7 +66,7 @@ AbstractSearch.return #### Defined in -[lib/search/search.ts:210](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L210) +[lib/search/search.ts:210](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L210) ## Methods @@ -102,7 +102,7 @@ An array of [Entities](Entity.md) matching the query. #### Defined in -[lib/search/search.ts:191](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L191) +[lib/search/search.ts:191](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L191) ___ @@ -126,7 +126,7 @@ A subclass of [WhereField](WhereField.md) matching the type of the field. #### Defined in -[lib/search/search.ts:340](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L340) +[lib/search/search.ts:340](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L340) ▸ **and**(`subSearchFn`): [`Search`](Search.md)<`TEntity`\> @@ -146,7 +146,7 @@ Sets up a nested search as a logical AND. #### Defined in -[lib/search/search.ts:347](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L347) +[lib/search/search.ts:347](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L347) ___ @@ -166,7 +166,7 @@ Returns the number of [Entities](Entity.md) that match this query. #### Defined in -[lib/search/search.ts:149](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L149) +[lib/search/search.ts:149](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L149) ___ @@ -186,7 +186,7 @@ Returns only the first [Entity](Entity.md) that matches this query. #### Defined in -[lib/search/search.ts:172](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L172) +[lib/search/search.ts:172](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L172) ___ @@ -214,7 +214,7 @@ The [Entity](Entity.md) with the maximal value #### Defined in -[lib/search/search.ts:141](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L141) +[lib/search/search.ts:141](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L141) ___ @@ -242,7 +242,7 @@ The [Entity](Entity.md) with the minimal value #### Defined in -[lib/search/search.ts:132](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L132) +[lib/search/search.ts:132](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L132) ___ @@ -266,7 +266,7 @@ A subclass of [WhereField](WhereField.md) matching the type of the field. #### Defined in -[lib/search/search.ts:357](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L357) +[lib/search/search.ts:357](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L357) ▸ **or**(`subSearchFn`): [`Search`](Search.md)<`TEntity`\> @@ -286,7 +286,7 @@ Sets up a nested search as a logical OR. #### Defined in -[lib/search/search.ts:364](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L364) +[lib/search/search.ts:364](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L364) ___ @@ -315,7 +315,7 @@ An array of [Entities](Entity.md) matching the query. #### Defined in -[lib/search/search.ts:162](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L162) +[lib/search/search.ts:162](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L162) ___ @@ -342,7 +342,7 @@ Alias for [Search.all](Search.md#all). #### Defined in -[lib/search/search.ts:245](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L245) +[lib/search/search.ts:245](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L245) ___ @@ -362,7 +362,7 @@ Alias for [Search.count](Search.md#count). #### Defined in -[lib/search/search.ts:231](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L231) +[lib/search/search.ts:231](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L231) ___ @@ -382,7 +382,7 @@ Alias for [Search.first](Search.md#first). #### Defined in -[lib/search/search.ts:252](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L252) +[lib/search/search.ts:252](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L252) ___ @@ -408,7 +408,7 @@ Alias for [Search.max](Search.md#max). #### Defined in -[lib/search/search.ts:224](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L224) +[lib/search/search.ts:224](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L224) ___ @@ -434,7 +434,7 @@ Alias for [Search.min](Search.md#min). #### Defined in -[lib/search/search.ts:217](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L217) +[lib/search/search.ts:217](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L217) ___ @@ -461,7 +461,7 @@ Alias for [Search.page](Search.md#page). #### Defined in -[lib/search/search.ts:238](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L238) +[lib/search/search.ts:238](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L238) ___ @@ -487,7 +487,7 @@ Alias for [Search.sortAscending](Search.md#sortascending). #### Defined in -[lib/search/search.ts:84](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L84) +[lib/search/search.ts:84](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L84) ___ @@ -515,7 +515,7 @@ this #### Defined in -[lib/search/search.ts:61](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L61) +[lib/search/search.ts:61](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L61) ___ @@ -544,7 +544,7 @@ this #### Defined in -[lib/search/search.ts:94](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L94) +[lib/search/search.ts:94](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L94) ___ @@ -570,7 +570,7 @@ Alias for [Search.sortDescending](Search.md#sortdescending). #### Defined in -[lib/search/search.ts:68](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L68) +[lib/search/search.ts:68](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L68) ___ @@ -598,7 +598,7 @@ this #### Defined in -[lib/search/search.ts:77](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L77) +[lib/search/search.ts:77](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L77) ___ @@ -623,7 +623,7 @@ A subclass of [WhereField](WhereField.md) matching the type of the field. #### Defined in -[lib/search/search.ts:322](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L322) +[lib/search/search.ts:322](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L322) ▸ **where**(`subSearchFn`): [`Search`](Search.md)<`TEntity`\> @@ -644,4 +644,4 @@ they are treated logically as AND. #### Defined in -[lib/search/search.ts:330](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L330) +[lib/search/search.ts:330](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L330) diff --git a/docs/classes/Where.md b/docs/classes/Where.md index ed4e0b61..d958a1f3 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/9268f6d/lib/search/where.ts#L8) +[lib/search/where.ts:8](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where.ts#L8) diff --git a/docs/classes/WhereField.md b/docs/classes/WhereField.md index 614b877e..6180b911 100644 --- a/docs/classes/WhereField.md +++ b/docs/classes/WhereField.md @@ -79,7 +79,7 @@ this multiple times will have no effect. #### Defined in -[lib/search/where-field.ts:92](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/where-field.ts#L92) +[lib/search/where-field.ts:92](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L92) ___ @@ -94,7 +94,7 @@ this multiple times will have no effect. #### Defined in -[lib/search/where-field.ts:99](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/where-field.ts#L99) +[lib/search/where-field.ts:99](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L99) ## Accessors @@ -112,7 +112,7 @@ this #### Defined in -[lib/search/where-field.ts:289](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/where-field.ts#L289) +[lib/search/where-field.ts:289](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L289) ___ @@ -130,7 +130,7 @@ this #### Defined in -[lib/search/where-field.ts:281](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/where-field.ts#L281) +[lib/search/where-field.ts:281](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L281) ___ @@ -149,7 +149,7 @@ this #### Defined in -[lib/search/where-field.ts:298](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/where-field.ts#L298) +[lib/search/where-field.ts:298](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L298) ## Methods @@ -173,7 +173,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/9268f6d/lib/search/where-field.ts#L240) +[lib/search/where-field.ts:240](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L240) ___ @@ -197,7 +197,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/9268f6d/lib/search/where-field.ts#L233) +[lib/search/where-field.ts:233](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L233) ___ @@ -222,7 +222,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/9268f6d/lib/search/where-field.ts#L175) +[lib/search/where-field.ts:175](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L175) ___ @@ -246,7 +246,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/9268f6d/lib/search/where-field.ts#L182) +[lib/search/where-field.ts:182](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L182) ___ @@ -271,7 +271,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/9268f6d/lib/search/where-field.ts#L197) +[lib/search/where-field.ts:197](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L197) ___ @@ -295,7 +295,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/9268f6d/lib/search/where-field.ts#L189) +[lib/search/where-field.ts:189](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L189) ___ @@ -320,7 +320,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/9268f6d/lib/search/where-field.ts#L205) +[lib/search/where-field.ts:205](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L205) ___ @@ -347,7 +347,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/9268f6d/lib/search/where-field.ts#L20) +[lib/search/where-field.ts:20](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L20) ___ @@ -374,7 +374,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/9268f6d/lib/search/where-field.ts#L30) +[lib/search/where-field.ts:30](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L30) ___ @@ -401,7 +401,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/9268f6d/lib/search/where-field.ts#L50) +[lib/search/where-field.ts:50](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L50) ___ @@ -428,7 +428,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/9268f6d/lib/search/where-field.ts#L40) +[lib/search/where-field.ts:40](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L40) ___ @@ -446,7 +446,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/9268f6d/lib/search/where-field.ts#L111) +[lib/search/where-field.ts:111](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L111) ___ @@ -470,7 +470,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/9268f6d/lib/search/where-field.ts#L125) +[lib/search/where-field.ts:125](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L125) ___ @@ -494,7 +494,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/9268f6d/lib/search/where-field.ts#L139) +[lib/search/where-field.ts:139](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L139) ___ @@ -518,7 +518,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/9268f6d/lib/search/where-field.ts#L118) +[lib/search/where-field.ts:118](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L118) ___ @@ -542,7 +542,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/9268f6d/lib/search/where-field.ts#L132) +[lib/search/where-field.ts:132](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L132) ___ @@ -566,7 +566,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/9268f6d/lib/search/where-field.ts#L212) +[lib/search/where-field.ts:212](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L212) ___ @@ -590,7 +590,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/9268f6d/lib/search/where-field.ts#L219) +[lib/search/where-field.ts:219](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L219) ___ @@ -614,7 +614,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/9268f6d/lib/search/where-field.ts#L153) +[lib/search/where-field.ts:153](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L153) ___ @@ -638,7 +638,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/9268f6d/lib/search/where-field.ts#L167) +[lib/search/where-field.ts:167](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L167) ___ @@ -662,7 +662,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/9268f6d/lib/search/where-field.ts#L146) +[lib/search/where-field.ts:146](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L146) ___ @@ -686,7 +686,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/9268f6d/lib/search/where-field.ts#L160) +[lib/search/where-field.ts:160](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L160) ___ @@ -710,7 +710,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/9268f6d/lib/search/where-field.ts#L57) +[lib/search/where-field.ts:57](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L57) ___ @@ -734,7 +734,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/9268f6d/lib/search/where-field.ts#L71) +[lib/search/where-field.ts:71](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L71) ___ @@ -758,7 +758,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/9268f6d/lib/search/where-field.ts#L78) +[lib/search/where-field.ts:78](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L78) ___ @@ -782,7 +782,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/9268f6d/lib/search/where-field.ts#L64) +[lib/search/where-field.ts:64](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L64) ___ @@ -806,7 +806,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/9268f6d/lib/search/where-field.ts#L85) +[lib/search/where-field.ts:85](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L85) ___ @@ -830,7 +830,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/9268f6d/lib/search/where-field.ts#L226) +[lib/search/where-field.ts:226](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L226) ___ @@ -854,7 +854,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/9268f6d/lib/search/where-field.ts#L254) +[lib/search/where-field.ts:254](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L254) ___ @@ -878,7 +878,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/9268f6d/lib/search/where-field.ts#L247) +[lib/search/where-field.ts:247](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L247) ___ @@ -898,7 +898,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/9268f6d/lib/search/where-field.ts#L303) +[lib/search/where-field.ts:303](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L303) ___ @@ -916,4 +916,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/9268f6d/lib/search/where-field.ts#L105) +[lib/search/where-field.ts:105](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-field.ts#L105) diff --git a/docs/interfaces/BaseFieldDefinition.md b/docs/interfaces/BaseFieldDefinition.md index 6d8b87ee..1a022531 100644 --- a/docs/interfaces/BaseFieldDefinition.md +++ b/docs/interfaces/BaseFieldDefinition.md @@ -27,6 +27,7 @@ Base interface for all fields. ### Properties - [alias](BaseFieldDefinition.md#alias) +- [indexed](BaseFieldDefinition.md#indexed) - [type](BaseFieldDefinition.md#type) ## Properties @@ -40,7 +41,20 @@ The default field name in Redis is the key name defined in the #### Defined in -[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/base-field-definition.ts#L12) +[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/base-field-definition.ts#L12) + +___ + +### indexed + +• `Optional` **indexed**: `boolean` + +Is this field indexed and thus searchable with Redis OM. Defaults +to the schema indexedDefault value, currently true. + +#### Defined in + +[lib/schema/definition/base-field-definition.ts:18](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/base-field-definition.ts#L18) ___ @@ -52,4 +66,4 @@ The type of the field (i.e. string, number, boolean, etc.) #### Defined in -[lib/schema/definition/base-field-definition.ts:6](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/base-field-definition.ts#L6) +[lib/schema/definition/base-field-definition.ts:6](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/base-field-definition.ts#L6) diff --git a/docs/interfaces/BooleanFieldDefinition.md b/docs/interfaces/BooleanFieldDefinition.md index c18766bd..cb7128d7 100644 --- a/docs/interfaces/BooleanFieldDefinition.md +++ b/docs/interfaces/BooleanFieldDefinition.md @@ -17,6 +17,7 @@ A field representing a boolean. ### Properties - [alias](BooleanFieldDefinition.md#alias) +- [indexed](BooleanFieldDefinition.md#indexed) - [sortable](BooleanFieldDefinition.md#sortable) - [type](BooleanFieldDefinition.md#type) @@ -35,7 +36,24 @@ The default field name in Redis is the key name defined in the #### Defined in -[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/base-field-definition.ts#L12) +[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/base-field-definition.ts#L12) + +___ + +### indexed + +• `Optional` **indexed**: `boolean` + +Is this field indexed and thus searchable with Redis OM. Defaults +to the schema indexedDefault value, currently true. + +#### Inherited from + +[BaseFieldDefinition](BaseFieldDefinition.md).[indexed](BaseFieldDefinition.md#indexed) + +#### Defined in + +[lib/schema/definition/base-field-definition.ts:18](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/base-field-definition.ts#L18) ___ @@ -51,7 +69,7 @@ Enables sorting by this field. #### Defined in -[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/sortable-field-definition.ts#L4) +[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/sortable-field-definition.ts#L4) ___ @@ -67,4 +85,4 @@ Yep. It's a boolean. #### Defined in -[lib/schema/definition/boolean-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/boolean-field-definition.ts#L7) +[lib/schema/definition/boolean-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/boolean-field-definition.ts#L7) diff --git a/docs/interfaces/CaseSensitiveFieldDefinition.md b/docs/interfaces/CaseSensitiveFieldDefinition.md new file mode 100644 index 00000000..3c2cd1c9 --- /dev/null +++ b/docs/interfaces/CaseSensitiveFieldDefinition.md @@ -0,0 +1,32 @@ +[redis-om](../README.md) / CaseSensitiveFieldDefinition + +# Interface: CaseSensitiveFieldDefinition + +Mixin for adding caseSensitive to a TAG field. + +## Hierarchy + +- **`CaseSensitiveFieldDefinition`** + + ↳ [`StringFieldDefinition`](StringFieldDefinition.md) + + ↳ [`StringArrayFieldDefinition`](StringArrayFieldDefinition.md) + +## Table of contents + +### Properties + +- [caseSensitive](CaseSensitiveFieldDefinition.md#casesensitive) + +## Properties + +### caseSensitive + +• `Optional` **caseSensitive**: `boolean` + +Is the original case of this field indexed with Redis OM. Defaults +to false. + +#### Defined in + +[lib/schema/definition/casesensitive-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/casesensitive-field-definition.ts#L7) diff --git a/docs/interfaces/DateFieldDefinition.md b/docs/interfaces/DateFieldDefinition.md index e645633e..431597d7 100644 --- a/docs/interfaces/DateFieldDefinition.md +++ b/docs/interfaces/DateFieldDefinition.md @@ -17,6 +17,7 @@ A field representing a date/time. ### Properties - [alias](DateFieldDefinition.md#alias) +- [indexed](DateFieldDefinition.md#indexed) - [sortable](DateFieldDefinition.md#sortable) - [type](DateFieldDefinition.md#type) @@ -35,7 +36,24 @@ The default field name in Redis is the key name defined in the #### Defined in -[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/base-field-definition.ts#L12) +[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/base-field-definition.ts#L12) + +___ + +### indexed + +• `Optional` **indexed**: `boolean` + +Is this field indexed and thus searchable with Redis OM. Defaults +to the schema indexedDefault value, currently true. + +#### Inherited from + +[BaseFieldDefinition](BaseFieldDefinition.md).[indexed](BaseFieldDefinition.md#indexed) + +#### Defined in + +[lib/schema/definition/base-field-definition.ts:18](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/base-field-definition.ts#L18) ___ @@ -51,7 +69,7 @@ Enables sorting by this field. #### Defined in -[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/sortable-field-definition.ts#L4) +[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/sortable-field-definition.ts#L4) ___ @@ -67,4 +85,4 @@ Yep. It's a date. #### Defined in -[lib/schema/definition/date-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/date-field-definition.ts#L7) +[lib/schema/definition/date-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/date-field-definition.ts#L7) diff --git a/docs/interfaces/NormalizedFieldDefinition.md b/docs/interfaces/NormalizedFieldDefinition.md new file mode 100644 index 00000000..6b7c421e --- /dev/null +++ b/docs/interfaces/NormalizedFieldDefinition.md @@ -0,0 +1,34 @@ +[redis-om](../README.md) / NormalizedFieldDefinition + +# Interface: NormalizedFieldDefinition + +Mixin for adding unf to a field. + +## Hierarchy + +- **`NormalizedFieldDefinition`** + + ↳ [`StringFieldDefinition`](StringFieldDefinition.md) + + ↳ [`StringArrayFieldDefinition`](StringArrayFieldDefinition.md) + + ↳ [`TextFieldDefinition`](TextFieldDefinition.md) + +## Table of contents + +### Properties + +- [normalized](NormalizedFieldDefinition.md#normalized) + +## Properties + +### normalized + +• `Optional` **normalized**: `boolean` + +Is this (sortable) field normalized when indexed. Defaults +to true. + +#### Defined in + +[lib/schema/definition/normalized-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/normalized-field-definition.ts#L7) diff --git a/docs/interfaces/NumberFieldDefinition.md b/docs/interfaces/NumberFieldDefinition.md index 57d11fd2..3f3fa17a 100644 --- a/docs/interfaces/NumberFieldDefinition.md +++ b/docs/interfaces/NumberFieldDefinition.md @@ -17,6 +17,7 @@ A field representing a number. ### Properties - [alias](NumberFieldDefinition.md#alias) +- [indexed](NumberFieldDefinition.md#indexed) - [sortable](NumberFieldDefinition.md#sortable) - [type](NumberFieldDefinition.md#type) @@ -35,7 +36,24 @@ The default field name in Redis is the key name defined in the #### Defined in -[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/base-field-definition.ts#L12) +[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/base-field-definition.ts#L12) + +___ + +### indexed + +• `Optional` **indexed**: `boolean` + +Is this field indexed and thus searchable with Redis OM. Defaults +to the schema indexedDefault value, currently true. + +#### Inherited from + +[BaseFieldDefinition](BaseFieldDefinition.md).[indexed](BaseFieldDefinition.md#indexed) + +#### Defined in + +[lib/schema/definition/base-field-definition.ts:18](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/base-field-definition.ts#L18) ___ @@ -51,7 +69,7 @@ Enables sorting by this field. #### Defined in -[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/sortable-field-definition.ts#L4) +[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/sortable-field-definition.ts#L4) ___ @@ -67,4 +85,4 @@ Yep. It's a number. #### Defined in -[lib/schema/definition/number-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/number-field-definition.ts#L7) +[lib/schema/definition/number-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/number-field-definition.ts#L7) diff --git a/docs/interfaces/PhoneticFieldDefinition.md b/docs/interfaces/PhoneticFieldDefinition.md new file mode 100644 index 00000000..b01b5aae --- /dev/null +++ b/docs/interfaces/PhoneticFieldDefinition.md @@ -0,0 +1,33 @@ +[redis-om](../README.md) / PhoneticFieldDefinition + +# Interface: PhoneticFieldDefinition + +Mixin for adding phonetic matching for TEXT fields in RediSearch. + +## Hierarchy + +- **`PhoneticFieldDefinition`** + + ↳ [`TextFieldDefinition`](TextFieldDefinition.md) + +## Table of contents + +### Properties + +- [matcher](PhoneticFieldDefinition.md#matcher) + +## Properties + +### matcher + +• `Optional` **matcher**: ``"dm:en"`` \| ``"dm:fr"`` \| ``"dm:pt"`` \| ``"dm:es"`` + +Enables setting the phonetic matcher to use, supported matchers are: +dm:en - Double Metaphone for English +dm:fr - Double Metaphone for French +dm:pt - Double Metaphone for Portuguese +dm:es - Double Metaphone for Spanish + +#### Defined in + +[lib/schema/definition/phonetic-field-definition.ts:10](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/phonetic-field-definition.ts#L10) diff --git a/docs/interfaces/PointFieldDefinition.md b/docs/interfaces/PointFieldDefinition.md index 304b60f3..4058dcd7 100644 --- a/docs/interfaces/PointFieldDefinition.md +++ b/docs/interfaces/PointFieldDefinition.md @@ -15,6 +15,7 @@ A field representing a point on the globe. ### Properties - [alias](PointFieldDefinition.md#alias) +- [indexed](PointFieldDefinition.md#indexed) - [type](PointFieldDefinition.md#type) ## Properties @@ -32,7 +33,24 @@ The default field name in Redis is the key name defined in the #### Defined in -[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/base-field-definition.ts#L12) +[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/base-field-definition.ts#L12) + +___ + +### indexed + +• `Optional` **indexed**: `boolean` + +Is this field indexed and thus searchable with Redis OM. Defaults +to the schema indexedDefault value, currently true. + +#### Inherited from + +[BaseFieldDefinition](BaseFieldDefinition.md).[indexed](BaseFieldDefinition.md#indexed) + +#### Defined in + +[lib/schema/definition/base-field-definition.ts:18](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/base-field-definition.ts#L18) ___ @@ -48,4 +66,4 @@ Yep. It's a point. #### Defined in -[lib/schema/definition/point-field-definition.ts:6](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/point-field-definition.ts#L6) +[lib/schema/definition/point-field-definition.ts:6](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/point-field-definition.ts#L6) diff --git a/docs/interfaces/SeparableFieldDefinition.md b/docs/interfaces/SeparableFieldDefinition.md index 1af88ece..a2579efa 100644 --- a/docs/interfaces/SeparableFieldDefinition.md +++ b/docs/interfaces/SeparableFieldDefinition.md @@ -31,4 +31,4 @@ those problems. Defaults to `|`. #### Defined in -[lib/schema/definition/separable-field-definition.ts:9](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/separable-field-definition.ts#L9) +[lib/schema/definition/separable-field-definition.ts:9](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/separable-field-definition.ts#L9) diff --git a/docs/interfaces/SortableFieldDefinition.md b/docs/interfaces/SortableFieldDefinition.md index 8124f1ad..79b0d9b8 100644 --- a/docs/interfaces/SortableFieldDefinition.md +++ b/docs/interfaces/SortableFieldDefinition.md @@ -16,6 +16,8 @@ Mixin for adding sortability to a field. ↳ [`StringFieldDefinition`](StringFieldDefinition.md) + ↳ [`StringArrayFieldDefinition`](StringArrayFieldDefinition.md) + ↳ [`TextFieldDefinition`](TextFieldDefinition.md) ## Table of contents @@ -34,4 +36,4 @@ Enables sorting by this field. #### Defined in -[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/sortable-field-definition.ts#L4) +[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/sortable-field-definition.ts#L4) diff --git a/docs/interfaces/StemmingFieldDefinition.md b/docs/interfaces/StemmingFieldDefinition.md new file mode 100644 index 00000000..5c316315 --- /dev/null +++ b/docs/interfaces/StemmingFieldDefinition.md @@ -0,0 +1,30 @@ +[redis-om](../README.md) / StemmingFieldDefinition + +# Interface: StemmingFieldDefinition + +Mixin for adding stemming to a field. + +## Hierarchy + +- **`StemmingFieldDefinition`** + + ↳ [`TextFieldDefinition`](TextFieldDefinition.md) + +## Table of contents + +### Properties + +- [stemming](StemmingFieldDefinition.md#stemming) + +## Properties + +### stemming + +• `Optional` **stemming**: `boolean` + +Is word stemming applied to this field with Redis OM. Defaults +to true. + +#### Defined in + +[lib/schema/definition/stemming-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/stemming-field-definition.ts#L7) diff --git a/docs/interfaces/StringArrayFieldDefinition.md b/docs/interfaces/StringArrayFieldDefinition.md index 410e25ba..d131e377 100644 --- a/docs/interfaces/StringArrayFieldDefinition.md +++ b/docs/interfaces/StringArrayFieldDefinition.md @@ -10,6 +10,12 @@ A field representing an array of strings. - [`SeparableFieldDefinition`](SeparableFieldDefinition.md) +- [`SortableFieldDefinition`](SortableFieldDefinition.md) + +- [`CaseSensitiveFieldDefinition`](CaseSensitiveFieldDefinition.md) + +- [`NormalizedFieldDefinition`](NormalizedFieldDefinition.md) + ↳ **`StringArrayFieldDefinition`** ## Table of contents @@ -17,7 +23,11 @@ A field representing an array of strings. ### Properties - [alias](StringArrayFieldDefinition.md#alias) +- [caseSensitive](StringArrayFieldDefinition.md#casesensitive) +- [indexed](StringArrayFieldDefinition.md#indexed) +- [normalized](StringArrayFieldDefinition.md#normalized) - [separator](StringArrayFieldDefinition.md#separator) +- [sortable](StringArrayFieldDefinition.md#sortable) - [type](StringArrayFieldDefinition.md#type) ## Properties @@ -35,7 +45,58 @@ The default field name in Redis is the key name defined in the #### Defined in -[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/base-field-definition.ts#L12) +[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/base-field-definition.ts#L12) + +___ + +### caseSensitive + +• `Optional` **caseSensitive**: `boolean` + +Is the original case of this field indexed with Redis OM. Defaults +to false. + +#### Inherited from + +[CaseSensitiveFieldDefinition](CaseSensitiveFieldDefinition.md).[caseSensitive](CaseSensitiveFieldDefinition.md#casesensitive) + +#### Defined in + +[lib/schema/definition/casesensitive-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/casesensitive-field-definition.ts#L7) + +___ + +### indexed + +• `Optional` **indexed**: `boolean` + +Is this field indexed and thus searchable with Redis OM. Defaults +to the schema indexedDefault value, currently true. + +#### Inherited from + +[BaseFieldDefinition](BaseFieldDefinition.md).[indexed](BaseFieldDefinition.md#indexed) + +#### Defined in + +[lib/schema/definition/base-field-definition.ts:18](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/base-field-definition.ts#L18) + +___ + +### normalized + +• `Optional` **normalized**: `boolean` + +Is this (sortable) field normalized when indexed. Defaults +to true. + +#### Inherited from + +[NormalizedFieldDefinition](NormalizedFieldDefinition.md).[normalized](NormalizedFieldDefinition.md#normalized) + +#### Defined in + +[lib/schema/definition/normalized-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/normalized-field-definition.ts#L7) ___ @@ -54,7 +115,23 @@ those problems. Defaults to `|`. #### Defined in -[lib/schema/definition/separable-field-definition.ts:9](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/separable-field-definition.ts#L9) +[lib/schema/definition/separable-field-definition.ts:9](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/separable-field-definition.ts#L9) + +___ + +### sortable + +• `Optional` **sortable**: `boolean` + +Enables sorting by this field. + +#### Inherited from + +[SortableFieldDefinition](SortableFieldDefinition.md).[sortable](SortableFieldDefinition.md#sortable) + +#### Defined in + +[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/sortable-field-definition.ts#L4) ___ @@ -70,4 +147,4 @@ Yep. It's a string array. #### Defined in -[lib/schema/definition/string-array-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/string-array-field-definition.ts#L7) +[lib/schema/definition/string-array-field-definition.ts:10](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/string-array-field-definition.ts#L10) diff --git a/docs/interfaces/StringFieldDefinition.md b/docs/interfaces/StringFieldDefinition.md index 048d9011..75246531 100644 --- a/docs/interfaces/StringFieldDefinition.md +++ b/docs/interfaces/StringFieldDefinition.md @@ -8,9 +8,13 @@ A field representing a whole string. - [`BaseFieldDefinition`](BaseFieldDefinition.md) +- [`SeparableFieldDefinition`](SeparableFieldDefinition.md) + - [`SortableFieldDefinition`](SortableFieldDefinition.md) -- [`SeparableFieldDefinition`](SeparableFieldDefinition.md) +- [`CaseSensitiveFieldDefinition`](CaseSensitiveFieldDefinition.md) + +- [`NormalizedFieldDefinition`](NormalizedFieldDefinition.md) ↳ **`StringFieldDefinition`** @@ -19,6 +23,9 @@ A field representing a whole string. ### Properties - [alias](StringFieldDefinition.md#alias) +- [caseSensitive](StringFieldDefinition.md#casesensitive) +- [indexed](StringFieldDefinition.md#indexed) +- [normalized](StringFieldDefinition.md#normalized) - [separator](StringFieldDefinition.md#separator) - [sortable](StringFieldDefinition.md#sortable) - [type](StringFieldDefinition.md#type) @@ -38,7 +45,58 @@ The default field name in Redis is the key name defined in the #### Defined in -[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/base-field-definition.ts#L12) +[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/base-field-definition.ts#L12) + +___ + +### caseSensitive + +• `Optional` **caseSensitive**: `boolean` + +Is the original case of this field indexed with Redis OM. Defaults +to false. + +#### Inherited from + +[CaseSensitiveFieldDefinition](CaseSensitiveFieldDefinition.md).[caseSensitive](CaseSensitiveFieldDefinition.md#casesensitive) + +#### Defined in + +[lib/schema/definition/casesensitive-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/casesensitive-field-definition.ts#L7) + +___ + +### indexed + +• `Optional` **indexed**: `boolean` + +Is this field indexed and thus searchable with Redis OM. Defaults +to the schema indexedDefault value, currently true. + +#### Inherited from + +[BaseFieldDefinition](BaseFieldDefinition.md).[indexed](BaseFieldDefinition.md#indexed) + +#### Defined in + +[lib/schema/definition/base-field-definition.ts:18](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/base-field-definition.ts#L18) + +___ + +### normalized + +• `Optional` **normalized**: `boolean` + +Is this (sortable) field normalized when indexed. Defaults +to true. + +#### Inherited from + +[NormalizedFieldDefinition](NormalizedFieldDefinition.md).[normalized](NormalizedFieldDefinition.md#normalized) + +#### Defined in + +[lib/schema/definition/normalized-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/normalized-field-definition.ts#L7) ___ @@ -57,7 +115,7 @@ those problems. Defaults to `|`. #### Defined in -[lib/schema/definition/separable-field-definition.ts:9](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/separable-field-definition.ts#L9) +[lib/schema/definition/separable-field-definition.ts:9](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/separable-field-definition.ts#L9) ___ @@ -73,7 +131,7 @@ Enables sorting by this field. #### Defined in -[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/sortable-field-definition.ts#L4) +[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/sortable-field-definition.ts#L4) ___ @@ -89,4 +147,4 @@ Yep. It's a string. #### Defined in -[lib/schema/definition/string-field-definition.ts:8](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/string-field-definition.ts#L8) +[lib/schema/definition/string-field-definition.ts:10](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/string-field-definition.ts#L10) diff --git a/docs/interfaces/TextFieldDefinition.md b/docs/interfaces/TextFieldDefinition.md index 3023cb16..02bef5fc 100644 --- a/docs/interfaces/TextFieldDefinition.md +++ b/docs/interfaces/TextFieldDefinition.md @@ -10,6 +10,14 @@ A field representing searchable text. - [`SortableFieldDefinition`](SortableFieldDefinition.md) +- [`StemmingFieldDefinition`](StemmingFieldDefinition.md) + +- [`PhoneticFieldDefinition`](PhoneticFieldDefinition.md) + +- [`NormalizedFieldDefinition`](NormalizedFieldDefinition.md) + +- [`WeightFieldDefinition`](WeightFieldDefinition.md) + ↳ **`TextFieldDefinition`** ## Table of contents @@ -17,8 +25,13 @@ A field representing searchable text. ### Properties - [alias](TextFieldDefinition.md#alias) +- [indexed](TextFieldDefinition.md#indexed) +- [matcher](TextFieldDefinition.md#matcher) +- [normalized](TextFieldDefinition.md#normalized) - [sortable](TextFieldDefinition.md#sortable) +- [stemming](TextFieldDefinition.md#stemming) - [type](TextFieldDefinition.md#type) +- [weight](TextFieldDefinition.md#weight) ## Properties @@ -35,7 +48,61 @@ The default field name in Redis is the key name defined in the #### Defined in -[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/base-field-definition.ts#L12) +[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/base-field-definition.ts#L12) + +___ + +### indexed + +• `Optional` **indexed**: `boolean` + +Is this field indexed and thus searchable with Redis OM. Defaults +to the schema indexedDefault value, currently true. + +#### Inherited from + +[BaseFieldDefinition](BaseFieldDefinition.md).[indexed](BaseFieldDefinition.md#indexed) + +#### Defined in + +[lib/schema/definition/base-field-definition.ts:18](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/base-field-definition.ts#L18) + +___ + +### matcher + +• `Optional` **matcher**: ``"dm:en"`` \| ``"dm:fr"`` \| ``"dm:pt"`` \| ``"dm:es"`` + +Enables setting the phonetic matcher to use, supported matchers are: +dm:en - Double Metaphone for English +dm:fr - Double Metaphone for French +dm:pt - Double Metaphone for Portuguese +dm:es - Double Metaphone for Spanish + +#### Inherited from + +[PhoneticFieldDefinition](PhoneticFieldDefinition.md).[matcher](PhoneticFieldDefinition.md#matcher) + +#### Defined in + +[lib/schema/definition/phonetic-field-definition.ts:10](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/phonetic-field-definition.ts#L10) + +___ + +### normalized + +• `Optional` **normalized**: `boolean` + +Is this (sortable) field normalized when indexed. Defaults +to true. + +#### Inherited from + +[NormalizedFieldDefinition](NormalizedFieldDefinition.md).[normalized](NormalizedFieldDefinition.md#normalized) + +#### Defined in + +[lib/schema/definition/normalized-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/normalized-field-definition.ts#L7) ___ @@ -51,7 +118,24 @@ Enables sorting by this field. #### Defined in -[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/sortable-field-definition.ts#L4) +[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/sortable-field-definition.ts#L4) + +___ + +### stemming + +• `Optional` **stemming**: `boolean` + +Is word stemming applied to this field with Redis OM. Defaults +to true. + +#### Inherited from + +[StemmingFieldDefinition](StemmingFieldDefinition.md).[stemming](StemmingFieldDefinition.md#stemming) + +#### Defined in + +[lib/schema/definition/stemming-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/stemming-field-definition.ts#L7) ___ @@ -67,4 +151,20 @@ Yep. It's searchable text. #### Defined in -[lib/schema/definition/text-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/text-field-definition.ts#L7) +[lib/schema/definition/text-field-definition.ts:11](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/text-field-definition.ts#L11) + +___ + +### weight + +• `Optional` **weight**: `number` + +Enables setting the weight to apply to a text field + +#### Inherited from + +[WeightFieldDefinition](WeightFieldDefinition.md).[weight](WeightFieldDefinition.md#weight) + +#### Defined in + +[lib/schema/definition/weight-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/weight-field-definition.ts#L4) diff --git a/docs/interfaces/WeightFieldDefinition.md b/docs/interfaces/WeightFieldDefinition.md new file mode 100644 index 00000000..9061ba89 --- /dev/null +++ b/docs/interfaces/WeightFieldDefinition.md @@ -0,0 +1,29 @@ +[redis-om](../README.md) / WeightFieldDefinition + +# Interface: WeightFieldDefinition + +Mixin for adding weight for TEXT fields in RediSearch. + +## Hierarchy + +- **`WeightFieldDefinition`** + + ↳ [`TextFieldDefinition`](TextFieldDefinition.md) + +## Table of contents + +### Properties + +- [weight](WeightFieldDefinition.md#weight) + +## Properties + +### weight + +• `Optional` **weight**: `number` + +Enables setting the weight to apply to a text field + +#### Defined in + +[lib/schema/definition/weight-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/weight-field-definition.ts#L4)