diff --git a/README.md b/README.md index b4e5b43d..1b192004 100644 --- a/README.md +++ b/README.md @@ -236,7 +236,7 @@ const point = { longitude: 12.34, latitude: 56.78 } A `text` field is a lot like a `string`. If you're just reading and writing objects, they are identical. But if you want to *search* on them, they are very, very different. I'll cover that in detail when I talk about [using RediSearch](#-using-redisearch) but the tl;dr is that `string` fields can only be matched on their whole value—no partial matches—and are best for keys while `text` fields have full-text search enabled on them and are optimized for human-readable text. -Additional field options can be set depending on the field type. These correspond to the [Field Options](https://redis.io/commands/ft.create/#field-options) avialable when creating a RediSearch full-text index. Other than the `separator` option, these only affect how content is indexed and searched. +Additional field options can be set depending on the field type. These correspond to the [Field Options](https://redis.io/commands/ft.create/#field-options) available when creating a RediSearch full-text index. Other than the `separator` option, these only affect how content is indexed and searched. | schema type | RediSearch type | `indexed` | `sortable` | `normalized` | `stemming` | `phonetic` | `weight` | `separator` | `caseSensitive` | | -------------- | :-------------: | :-------: | :--------: | :----------: | :--------: | :--------: | :------: | :---------: | :-------------: | diff --git a/docs/README.md b/docs/README.md index 890676ae..dd03854b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -77,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/47d4d36/lib/search/where-point.ts#L9) +[lib/search/where-point.ts:9](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/where-point.ts#L9) ___ @@ -89,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/47d4d36/lib/schema/options/data-structure.ts#L2) +[lib/schema/options/data-structure.ts:2](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/options/data-structure.ts#L2) ___ @@ -119,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/47d4d36/lib/entity/entity-constructor.ts#L8) +[lib/entity/entity-constructor.ts:8](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/entity/entity-constructor.ts#L8) ___ @@ -131,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/47d4d36/lib/entity/entity-data.ts#L6) +[lib/entity/entity-data.ts:6](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/entity/entity-data.ts#L6) ___ @@ -143,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/47d4d36/lib/entity/entity-value.ts#L6) +[lib/entity/entity-value.ts:6](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/entity/entity-value.ts#L6) ___ @@ -155,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/47d4d36/lib/schema/definition/field-definition.ts#L10) +[lib/schema/definition/field-definition.ts:10](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/field-definition.ts#L10) ___ @@ -175,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/47d4d36/lib/schema/options/id-strategy.ts#L2) +[lib/schema/options/id-strategy.ts:2](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/options/id-strategy.ts#L2) ___ @@ -194,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/47d4d36/lib/entity/point.ts#L2) +[lib/entity/point.ts:2](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/entity/point.ts#L2) ___ @@ -206,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/47d4d36/lib/schema/definition/schema-definition.ts#L6) +[lib/schema/definition/schema-definition.ts:6](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/schema-definition.ts#L6) ___ @@ -218,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/47d4d36/lib/schema/definition/schema-field-type.ts#L4) +[lib/schema/definition/schema-field-type.ts:4](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/schema-field-type.ts#L4) ___ @@ -243,7 +243,7 @@ Configuration options for a [Schema](classes/Schema.md). #### Defined in -[lib/schema/options/schema-options.ts:9](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/options/schema-options.ts#L9) +[lib/schema/options/schema-options.ts:9](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/options/schema-options.ts#L9) ___ @@ -255,7 +255,7 @@ The type of data structure in Redis to map objects to. #### Defined in -[lib/client.ts:23](https://github.com/redis/redis-om-node/blob/47d4d36/lib/client.ts#L23) +[lib/client.ts:23](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/client.ts#L23) ___ @@ -267,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/47d4d36/lib/schema/options/stop-word-options.ts#L2) +[lib/schema/options/stop-word-options.ts:2](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/options/stop-word-options.ts#L2) ___ @@ -299,4 +299,4 @@ A function that takes a [Search](classes/Search.md) and returns a [Search](class #### Defined in -[lib/search/search.ts:26](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L26) +[lib/search/search.ts:26](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L26) diff --git a/docs/classes/AbstractSearch.md b/docs/classes/AbstractSearch.md index b59e646e..d657e1b9 100644 --- a/docs/classes/AbstractSearch.md +++ b/docs/classes/AbstractSearch.md @@ -81,7 +81,7 @@ this #### Defined in -[lib/search/search.ts:333](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L333) +[lib/search/search.ts:333](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L333) ## Methods @@ -113,7 +113,7 @@ An array of [Entities](Entity.md) matching the query. #### Defined in -[lib/search/search.ts:266](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L266) +[lib/search/search.ts:266](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L266) ___ @@ -145,7 +145,7 @@ An array of entity IDs matching the query. #### Defined in -[lib/search/search.ts:295](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L295) +[lib/search/search.ts:295](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L295) ___ @@ -177,7 +177,7 @@ An array of key names matching the query. #### Defined in -[lib/search/search.ts:314](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L314) +[lib/search/search.ts:314](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L314) ___ @@ -193,7 +193,7 @@ Returns the number of [Entities](Entity.md) that match this query. #### Defined in -[lib/search/search.ts:186](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L186) +[lib/search/search.ts:186](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L186) ___ @@ -209,7 +209,7 @@ Returns the first [Entity](Entity.md) that matches this query. #### Defined in -[lib/search/search.ts:231](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L231) +[lib/search/search.ts:231](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L231) ___ @@ -225,7 +225,7 @@ Returns the first entity ID that matches this query. #### Defined in -[lib/search/search.ts:239](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L239) +[lib/search/search.ts:239](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L239) ___ @@ -241,7 +241,7 @@ Returns the first key name that matches this query. #### Defined in -[lib/search/search.ts:247](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L247) +[lib/search/search.ts:247](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L247) ___ @@ -265,7 +265,7 @@ The entity ID [Entity](Entity.md) with the maximal value #### Defined in -[lib/search/search.ts:159](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L159) +[lib/search/search.ts:159](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L159) ___ @@ -289,7 +289,7 @@ The entity ID with the maximal value #### Defined in -[lib/search/search.ts:168](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L168) +[lib/search/search.ts:168](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L168) ___ @@ -313,7 +313,7 @@ The key name with the maximal value #### Defined in -[lib/search/search.ts:178](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L178) +[lib/search/search.ts:178](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L178) ___ @@ -337,7 +337,7 @@ The [Entity](Entity.md) with the minimal value #### Defined in -[lib/search/search.ts:131](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L131) +[lib/search/search.ts:131](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L131) ___ @@ -361,7 +361,7 @@ The entity ID with the minimal value #### Defined in -[lib/search/search.ts:140](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L140) +[lib/search/search.ts:140](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L140) ___ @@ -385,7 +385,7 @@ The key name with the minimal value #### Defined in -[lib/search/search.ts:150](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L150) +[lib/search/search.ts:150](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L150) ___ @@ -410,7 +410,7 @@ An array of [Entities](Entity.md) matching the query. #### Defined in -[lib/search/search.ts:199](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L199) +[lib/search/search.ts:199](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L199) ___ @@ -435,7 +435,7 @@ An array of strings matching the query. #### Defined in -[lib/search/search.ts:212](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L212) +[lib/search/search.ts:212](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L212) ___ @@ -460,7 +460,7 @@ An array of strings matching the query. #### Defined in -[lib/search/search.ts:223](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L223) +[lib/search/search.ts:223](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L223) ___ @@ -483,7 +483,7 @@ Alias for [Search.all](Search.md#all). #### Defined in -[lib/search/search.ts:431](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L431) +[lib/search/search.ts:431](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L431) ___ @@ -506,7 +506,7 @@ Alias for [Search.allIds](Search.md#allids). #### Defined in -[lib/search/search.ts:438](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L438) +[lib/search/search.ts:438](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L438) ___ @@ -529,7 +529,7 @@ Alias for [Search.allKeys](Search.md#allkeys). #### Defined in -[lib/search/search.ts:445](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L445) +[lib/search/search.ts:445](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L445) ___ @@ -545,7 +545,7 @@ Alias for [Search.count](Search.md#count). #### Defined in -[lib/search/search.ts:382](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L382) +[lib/search/search.ts:382](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L382) ___ @@ -561,7 +561,7 @@ Alias for [Search.first](Search.md#first). #### Defined in -[lib/search/search.ts:410](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L410) +[lib/search/search.ts:410](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L410) ___ @@ -577,7 +577,7 @@ Alias for [Search.firstId](Search.md#firstid). #### Defined in -[lib/search/search.ts:417](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L417) +[lib/search/search.ts:417](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L417) ___ @@ -593,7 +593,7 @@ Alias for [Search.firstKey](Search.md#firstkey). #### Defined in -[lib/search/search.ts:424](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L424) +[lib/search/search.ts:424](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L424) ___ @@ -615,7 +615,7 @@ Alias for [Search.max](Search.md#max). #### Defined in -[lib/search/search.ts:361](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L361) +[lib/search/search.ts:361](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L361) ___ @@ -637,7 +637,7 @@ Alias for [Search.maxId](Search.md#maxid). #### Defined in -[lib/search/search.ts:368](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L368) +[lib/search/search.ts:368](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L368) ___ @@ -659,7 +659,7 @@ Alias for [Search.maxKey](Search.md#maxkey). #### Defined in -[lib/search/search.ts:375](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L375) +[lib/search/search.ts:375](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L375) ___ @@ -681,7 +681,7 @@ Alias for [Search.min](Search.md#min). #### Defined in -[lib/search/search.ts:340](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L340) +[lib/search/search.ts:340](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L340) ___ @@ -703,7 +703,7 @@ Alias for [Search.minId](Search.md#minid). #### Defined in -[lib/search/search.ts:347](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L347) +[lib/search/search.ts:347](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L347) ___ @@ -725,7 +725,7 @@ Alias for [Search.minKey](Search.md#minkey). #### Defined in -[lib/search/search.ts:354](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L354) +[lib/search/search.ts:354](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L354) ___ @@ -748,7 +748,7 @@ Alias for [Search.page](Search.md#page). #### Defined in -[lib/search/search.ts:389](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L389) +[lib/search/search.ts:389](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L389) ___ @@ -771,7 +771,7 @@ Alias for [Search.pageOfIds](Search.md#pageofids). #### Defined in -[lib/search/search.ts:396](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L396) +[lib/search/search.ts:396](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L396) ___ @@ -794,7 +794,7 @@ Alias for {@link Search.pageOrKeys}. #### Defined in -[lib/search/search.ts:403](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L403) +[lib/search/search.ts:403](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L403) ___ @@ -816,7 +816,7 @@ Alias for [Search.sortAscending](Search.md#sortascending). #### Defined in -[lib/search/search.ts:83](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L83) +[lib/search/search.ts:83](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L83) ___ @@ -840,7 +840,7 @@ this #### Defined in -[lib/search/search.ts:60](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L60) +[lib/search/search.ts:60](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L60) ___ @@ -865,7 +865,7 @@ this #### Defined in -[lib/search/search.ts:93](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L93) +[lib/search/search.ts:93](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L93) ___ @@ -887,7 +887,7 @@ Alias for [Search.sortDescending](Search.md#sortdescending). #### Defined in -[lib/search/search.ts:67](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L67) +[lib/search/search.ts:67](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L67) ___ @@ -911,4 +911,4 @@ this #### Defined in -[lib/search/search.ts:76](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L76) +[lib/search/search.ts:76](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L76) diff --git a/docs/classes/Circle.md b/docs/classes/Circle.md index ae333483..2c285020 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/47d4d36/lib/search/where-point.ts#L150) +[lib/search/where-point.ts:150](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-point.ts#L144) +[lib/search/where-point.ts:144](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-point.ts#L138) +[lib/search/where-point.ts:138](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-point.ts#L123) +[lib/search/where-point.ts:123](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-point.ts#L129) +[lib/search/where-point.ts:129](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-point.ts#L117) +[lib/search/where-point.ts:117](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-point.ts#L96) +[lib/search/where-point.ts:96](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-point.ts#L102) +[lib/search/where-point.ts:102](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-point.ts#L108) +[lib/search/where-point.ts:108](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-point.ts#L159) +[lib/search/where-point.ts:159](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-point.ts#L165) +[lib/search/where-point.ts:165](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-point.ts#L171) +[lib/search/where-point.ts:171](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-point.ts#L43) +[lib/search/where-point.ts:43](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-point.ts#L32) +[lib/search/where-point.ts:32](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-point.ts#L87) +[lib/search/where-point.ts:87](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/where-point.ts#L87) diff --git a/docs/classes/Client.md b/docs/classes/Client.md index b20946be..300e49f2 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:131](https://github.com/redis/redis-om-node/blob/47d4d36/lib/client.ts#L131) +[lib/client.ts:131](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/client.ts#L131) ___ @@ -73,7 +73,7 @@ The raw results of calling the Redis command. #### Defined in -[lib/client.ts:104](https://github.com/redis/redis-om-node/blob/47d4d36/lib/client.ts#L104) +[lib/client.ts:104](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/client.ts#L104) ___ @@ -103,7 +103,7 @@ A repository for the provided schema. #### Defined in -[lib/client.ts:119](https://github.com/redis/redis-om-node/blob/47d4d36/lib/client.ts#L119) +[lib/client.ts:119](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/client.ts#L119) ___ @@ -119,7 +119,7 @@ Whether a connection is already open. #### Defined in -[lib/client.ts:245](https://github.com/redis/redis-om-node/blob/47d4d36/lib/client.ts#L245) +[lib/client.ts:245](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/client.ts#L245) ___ @@ -143,7 +143,7 @@ This [Client](Client.md) instance. #### Defined in -[lib/client.ts:90](https://github.com/redis/redis-om-node/blob/47d4d36/lib/client.ts#L90) +[lib/client.ts:90](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/client.ts#L90) ___ @@ -168,4 +168,4 @@ This [Client](Client.md) instance. #### Defined in -[lib/client.ts:78](https://github.com/redis/redis-om-node/blob/47d4d36/lib/client.ts#L78) +[lib/client.ts:78](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/client.ts#L78) diff --git a/docs/classes/Entity.md b/docs/classes/Entity.md index 5bfaf4b7..7b39dc43 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:37](https://github.com/redis/redis-om-node/blob/47d4d36/lib/entity/entity.ts#L37) +[lib/entity/entity.ts:37](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/entity/entity.ts#L37) ## Accessors @@ -49,7 +49,7 @@ The keyname this [Entity](Entity.md) is stored with in Redis. #### Defined in -[lib/entity/entity.ts:73](https://github.com/redis/redis-om-node/blob/47d4d36/lib/entity/entity.ts#L73) +[lib/entity/entity.ts:73](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/entity/entity.ts#L73) ## Methods @@ -67,4 +67,4 @@ a JavaScript object. #### Defined in -[lib/entity/entity.ts:81](https://github.com/redis/redis-om-node/blob/47d4d36/lib/entity/entity.ts#L81) +[lib/entity/entity.ts:81](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/entity/entity.ts#L81) diff --git a/docs/classes/RawSearch.md b/docs/classes/RawSearch.md index 9c6de243..64bb1254 100644 --- a/docs/classes/RawSearch.md +++ b/docs/classes/RawSearch.md @@ -84,7 +84,7 @@ AbstractSearch.return #### Defined in -[lib/search/search.ts:333](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L333) +[lib/search/search.ts:333](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L333) ## Methods @@ -120,7 +120,7 @@ An array of [Entities](Entity.md) matching the query. #### Defined in -[lib/search/search.ts:266](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L266) +[lib/search/search.ts:266](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L266) ___ @@ -156,7 +156,7 @@ An array of entity IDs matching the query. #### Defined in -[lib/search/search.ts:295](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L295) +[lib/search/search.ts:295](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L295) ___ @@ -192,7 +192,7 @@ An array of key names matching the query. #### Defined in -[lib/search/search.ts:314](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L314) +[lib/search/search.ts:314](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L314) ___ @@ -212,7 +212,7 @@ Returns the number of [Entities](Entity.md) that match this query. #### Defined in -[lib/search/search.ts:186](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L186) +[lib/search/search.ts:186](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L186) ___ @@ -232,7 +232,7 @@ Returns the first [Entity](Entity.md) that matches this query. #### Defined in -[lib/search/search.ts:231](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L231) +[lib/search/search.ts:231](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L231) ___ @@ -252,7 +252,7 @@ Returns the first entity ID that matches this query. #### Defined in -[lib/search/search.ts:239](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L239) +[lib/search/search.ts:239](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L239) ___ @@ -272,7 +272,7 @@ Returns the first key name that matches this query. #### Defined in -[lib/search/search.ts:247](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L247) +[lib/search/search.ts:247](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L247) ___ @@ -300,7 +300,7 @@ The entity ID [Entity](Entity.md) with the maximal value #### Defined in -[lib/search/search.ts:159](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L159) +[lib/search/search.ts:159](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L159) ___ @@ -328,7 +328,7 @@ The entity ID with the maximal value #### Defined in -[lib/search/search.ts:168](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L168) +[lib/search/search.ts:168](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L168) ___ @@ -356,7 +356,7 @@ The key name with the maximal value #### Defined in -[lib/search/search.ts:178](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L178) +[lib/search/search.ts:178](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L178) ___ @@ -384,7 +384,7 @@ The [Entity](Entity.md) with the minimal value #### Defined in -[lib/search/search.ts:131](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L131) +[lib/search/search.ts:131](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L131) ___ @@ -412,7 +412,7 @@ The entity ID with the minimal value #### Defined in -[lib/search/search.ts:140](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L140) +[lib/search/search.ts:140](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L140) ___ @@ -440,7 +440,7 @@ The key name with the minimal value #### Defined in -[lib/search/search.ts:150](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L150) +[lib/search/search.ts:150](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L150) ___ @@ -469,7 +469,7 @@ An array of [Entities](Entity.md) matching the query. #### Defined in -[lib/search/search.ts:199](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L199) +[lib/search/search.ts:199](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L199) ___ @@ -498,7 +498,7 @@ An array of strings matching the query. #### Defined in -[lib/search/search.ts:212](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L212) +[lib/search/search.ts:212](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L212) ___ @@ -527,7 +527,7 @@ An array of strings matching the query. #### Defined in -[lib/search/search.ts:223](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L223) +[lib/search/search.ts:223](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L223) ___ @@ -554,7 +554,7 @@ Alias for [Search.all](Search.md#all). #### Defined in -[lib/search/search.ts:431](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L431) +[lib/search/search.ts:431](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L431) ___ @@ -581,7 +581,7 @@ Alias for [Search.allIds](Search.md#allids). #### Defined in -[lib/search/search.ts:438](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L438) +[lib/search/search.ts:438](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L438) ___ @@ -608,7 +608,7 @@ Alias for [Search.allKeys](Search.md#allkeys). #### Defined in -[lib/search/search.ts:445](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L445) +[lib/search/search.ts:445](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L445) ___ @@ -628,7 +628,7 @@ Alias for [Search.count](Search.md#count). #### Defined in -[lib/search/search.ts:382](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L382) +[lib/search/search.ts:382](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L382) ___ @@ -648,7 +648,7 @@ Alias for [Search.first](Search.md#first). #### Defined in -[lib/search/search.ts:410](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L410) +[lib/search/search.ts:410](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L410) ___ @@ -668,7 +668,7 @@ Alias for [Search.firstId](Search.md#firstid). #### Defined in -[lib/search/search.ts:417](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L417) +[lib/search/search.ts:417](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L417) ___ @@ -688,7 +688,7 @@ Alias for [Search.firstKey](Search.md#firstkey). #### Defined in -[lib/search/search.ts:424](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L424) +[lib/search/search.ts:424](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L424) ___ @@ -714,7 +714,7 @@ Alias for [Search.max](Search.md#max). #### Defined in -[lib/search/search.ts:361](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L361) +[lib/search/search.ts:361](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L361) ___ @@ -740,7 +740,7 @@ Alias for [Search.maxId](Search.md#maxid). #### Defined in -[lib/search/search.ts:368](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L368) +[lib/search/search.ts:368](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L368) ___ @@ -766,7 +766,7 @@ Alias for [Search.maxKey](Search.md#maxkey). #### Defined in -[lib/search/search.ts:375](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L375) +[lib/search/search.ts:375](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L375) ___ @@ -792,7 +792,7 @@ Alias for [Search.min](Search.md#min). #### Defined in -[lib/search/search.ts:340](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L340) +[lib/search/search.ts:340](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L340) ___ @@ -818,7 +818,7 @@ Alias for [Search.minId](Search.md#minid). #### Defined in -[lib/search/search.ts:347](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L347) +[lib/search/search.ts:347](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L347) ___ @@ -844,7 +844,7 @@ Alias for [Search.minKey](Search.md#minkey). #### Defined in -[lib/search/search.ts:354](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L354) +[lib/search/search.ts:354](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L354) ___ @@ -871,7 +871,7 @@ Alias for [Search.page](Search.md#page). #### Defined in -[lib/search/search.ts:389](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L389) +[lib/search/search.ts:389](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L389) ___ @@ -898,7 +898,7 @@ Alias for [Search.pageOfIds](Search.md#pageofids). #### Defined in -[lib/search/search.ts:396](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L396) +[lib/search/search.ts:396](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L396) ___ @@ -925,7 +925,7 @@ Alias for {@link Search.pageOrKeys}. #### Defined in -[lib/search/search.ts:403](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L403) +[lib/search/search.ts:403](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L403) ___ @@ -951,7 +951,7 @@ Alias for [Search.sortAscending](Search.md#sortascending). #### Defined in -[lib/search/search.ts:83](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L83) +[lib/search/search.ts:83](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L83) ___ @@ -979,7 +979,7 @@ this #### Defined in -[lib/search/search.ts:60](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L60) +[lib/search/search.ts:60](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L60) ___ @@ -1008,7 +1008,7 @@ this #### Defined in -[lib/search/search.ts:93](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L93) +[lib/search/search.ts:93](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L93) ___ @@ -1034,7 +1034,7 @@ Alias for [Search.sortDescending](Search.md#sortdescending). #### Defined in -[lib/search/search.ts:67](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L67) +[lib/search/search.ts:67](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L67) ___ @@ -1062,4 +1062,4 @@ this #### Defined in -[lib/search/search.ts:76](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L76) +[lib/search/search.ts:76](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L76) diff --git a/docs/classes/RedisError.md b/docs/classes/RedisError.md index 30aa08fd..fc9d1572 100644 --- a/docs/classes/RedisError.md +++ b/docs/classes/RedisError.md @@ -45,7 +45,7 @@ Error.constructor #### Defined in -[lib/errors.ts:2](https://github.com/redis/redis-om-node/blob/47d4d36/lib/errors.ts#L2) +[lib/errors.ts:2](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/errors.ts#L2) ## Properties diff --git a/docs/classes/Repository.md b/docs/classes/Repository.md index 0549cf96..e433e2a9 100644 --- a/docs/classes/Repository.md +++ b/docs/classes/Repository.md @@ -71,7 +71,7 @@ const entities = await repository.search() #### Defined in -[lib/repository/index.ts:49](https://github.com/redis/redis-om-node/blob/47d4d36/lib/repository/index.ts#L49) +[lib/repository/index.ts:49](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/repository/index.ts#L49) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -[lib/repository/index.ts:50](https://github.com/redis/redis-om-node/blob/47d4d36/lib/repository/index.ts#L50) +[lib/repository/index.ts:50](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/repository/index.ts#L50) ## Methods @@ -106,7 +106,7 @@ The newly created and saved Entity. #### Defined in -[lib/repository/index.ts:130](https://github.com/redis/redis-om-node/blob/47d4d36/lib/repository/index.ts#L130) +[lib/repository/index.ts:130](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/repository/index.ts#L130) ___ @@ -130,7 +130,7 @@ A newly created Entity. #### Defined in -[lib/repository/index.ts:108](https://github.com/redis/redis-om-node/blob/47d4d36/lib/repository/index.ts#L108) +[lib/repository/index.ts:108](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/repository/index.ts#L108) ___ @@ -147,7 +147,7 @@ that RediSearch or RedisJSON is installed on your instance of Redis. #### Defined in -[lib/repository/index.ts:62](https://github.com/redis/redis-om-node/blob/47d4d36/lib/repository/index.ts#L62) +[lib/repository/index.ts:62](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/repository/index.ts#L62) ___ @@ -165,7 +165,7 @@ on your instance of Redis. #### Defined in -[lib/repository/index.ts:90](https://github.com/redis/redis-om-node/blob/47d4d36/lib/repository/index.ts#L90) +[lib/repository/index.ts:90](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/repository/index.ts#L90) ___ @@ -181,7 +181,7 @@ found, does nothing. | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | The ID of the [Entity](Entity.md) to set and expiration for. | -| `ttlInSeconds` | `number` | THe time to live in seconds. | +| `ttlInSeconds` | `number` | The time to live in seconds. | #### Returns @@ -189,7 +189,7 @@ found, does nothing. #### Defined in -[lib/repository/index.ts:214](https://github.com/redis/redis-om-node/blob/47d4d36/lib/repository/index.ts#L214) +[lib/repository/index.ts:214](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/repository/index.ts#L214) ___ @@ -215,7 +215,7 @@ The matching Entity. #### Defined in -[lib/repository/index.ts:143](https://github.com/redis/redis-om-node/blob/47d4d36/lib/repository/index.ts#L143) +[lib/repository/index.ts:143](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/repository/index.ts#L143) ▸ **fetch**(...`ids`): `Promise`<`TEntity`[]\> @@ -237,7 +237,7 @@ The matching Entities. #### Defined in -[lib/repository/index.ts:152](https://github.com/redis/redis-om-node/blob/47d4d36/lib/repository/index.ts#L152) +[lib/repository/index.ts:152](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/repository/index.ts#L152) ▸ **fetch**(`ids`): `Promise`<`TEntity`[]\> @@ -259,7 +259,7 @@ The matching Entities. #### Defined in -[lib/repository/index.ts:161](https://github.com/redis/redis-om-node/blob/47d4d36/lib/repository/index.ts#L161) +[lib/repository/index.ts:161](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/repository/index.ts#L161) ___ @@ -282,7 +282,7 @@ not found, does nothing. #### Defined in -[lib/repository/index.ts:181](https://github.com/redis/redis-om-node/blob/47d4d36/lib/repository/index.ts#L181) +[lib/repository/index.ts:181](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/repository/index.ts#L181) ▸ **remove**(...`ids`): `Promise`<`void`\> @@ -301,7 +301,7 @@ particular [Entity](Entity.md) is not found, does nothing. #### Defined in -[lib/repository/index.ts:188](https://github.com/redis/redis-om-node/blob/47d4d36/lib/repository/index.ts#L188) +[lib/repository/index.ts:188](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/repository/index.ts#L188) ▸ **remove**(`ids`): `Promise`<`void`\> @@ -320,7 +320,7 @@ particular [Entity](Entity.md) is not found, does nothing. #### Defined in -[lib/repository/index.ts:195](https://github.com/redis/redis-om-node/blob/47d4d36/lib/repository/index.ts#L195) +[lib/repository/index.ts:195](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/repository/index.ts#L195) ___ @@ -345,7 +345,7 @@ The ID of the Entity just saved. #### Defined in -[lib/repository/index.ts:119](https://github.com/redis/redis-om-node/blob/47d4d36/lib/repository/index.ts#L119) +[lib/repository/index.ts:119](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/repository/index.ts#L119) ___ @@ -364,7 +364,7 @@ A [Search](Search.md) object. #### Defined in -[lib/repository/index.ts:225](https://github.com/redis/redis-om-node/blob/47d4d36/lib/repository/index.ts#L225) +[lib/repository/index.ts:225](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/repository/index.ts#L225) ___ @@ -392,4 +392,4 @@ A [RawSearch](RawSearch.md) object. #### Defined in -[lib/repository/index.ts:237](https://github.com/redis/redis-om-node/blob/47d4d36/lib/repository/index.ts#L237) +[lib/repository/index.ts:237](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/repository/index.ts#L237) diff --git a/docs/classes/Schema.md b/docs/classes/Schema.md index b1125d68..d692027d 100644 --- a/docs/classes/Schema.md +++ b/docs/classes/Schema.md @@ -72,7 +72,7 @@ its constructor. #### Defined in -[lib/schema/schema.ts:57](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/schema.ts#L57) +[lib/schema/schema.ts:57](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/schema.ts#L57) ## Accessors @@ -89,7 +89,7 @@ that this Schema uses to store [Entities](Entity.md) in Redis. #### Defined in -[lib/schema/schema.ts:79](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/schema.ts#L79) +[lib/schema/schema.ts:79](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/schema.ts#L79) ___ @@ -105,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/47d4d36/lib/schema/schema.ts#L100) +[lib/schema/schema.ts:100](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/schema.ts#L100) ___ @@ -121,7 +121,7 @@ The configured name for the RediSearch index hash for this Schema. #### Defined in -[lib/schema/schema.ts:73](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/schema.ts#L73) +[lib/schema/schema.ts:73](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/schema.ts#L73) ___ @@ -137,7 +137,7 @@ The configured name for the RediSearch index for this Schema. #### Defined in -[lib/schema/schema.ts:70](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/schema.ts#L70) +[lib/schema/schema.ts:70](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/schema.ts#L70) ___ @@ -153,7 +153,7 @@ The configured indexed default setting for fields #### Defined in -[lib/schema/schema.ts:97](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/schema.ts#L97) +[lib/schema/schema.ts:97](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/schema.ts#L97) ___ @@ -169,7 +169,7 @@ The configured keyspace prefix in Redis for this Schema. #### Defined in -[lib/schema/schema.ts:67](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/schema.ts#L67) +[lib/schema/schema.ts:67](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/schema.ts#L67) ___ @@ -186,7 +186,7 @@ than `CUSTOM`. #### Defined in -[lib/schema/schema.ts:92](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/schema.ts#L92) +[lib/schema/schema.ts:92](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/schema.ts#L92) ___ @@ -204,7 +204,7 @@ for more details. #### Defined in -[lib/schema/schema.ts:86](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/schema.ts#L86) +[lib/schema/schema.ts:86](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/schema.ts#L86) ## Methods @@ -220,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/47d4d36/lib/schema/schema.ts#L126) +[lib/schema/schema.ts:126](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/schema.ts#L126) diff --git a/docs/classes/Search.md b/docs/classes/Search.md index 2f040688..244f728b 100644 --- a/docs/classes/Search.md +++ b/docs/classes/Search.md @@ -86,7 +86,7 @@ AbstractSearch.return #### Defined in -[lib/search/search.ts:333](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L333) +[lib/search/search.ts:333](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L333) ## Methods @@ -122,7 +122,7 @@ An array of [Entities](Entity.md) matching the query. #### Defined in -[lib/search/search.ts:266](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L266) +[lib/search/search.ts:266](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L266) ___ @@ -158,7 +158,7 @@ An array of entity IDs matching the query. #### Defined in -[lib/search/search.ts:295](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L295) +[lib/search/search.ts:295](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L295) ___ @@ -194,7 +194,7 @@ An array of key names matching the query. #### Defined in -[lib/search/search.ts:314](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L314) +[lib/search/search.ts:314](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L314) ___ @@ -218,7 +218,7 @@ A subclass of [WhereField](WhereField.md) matching the type of the field. #### Defined in -[lib/search/search.ts:542](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L542) +[lib/search/search.ts:542](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L542) ▸ **and**(`subSearchFn`): [`Search`](Search.md)<`TEntity`\> @@ -238,7 +238,7 @@ Sets up a nested search as a logical AND. #### Defined in -[lib/search/search.ts:549](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L549) +[lib/search/search.ts:549](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L549) ___ @@ -258,7 +258,7 @@ Returns the number of [Entities](Entity.md) that match this query. #### Defined in -[lib/search/search.ts:186](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L186) +[lib/search/search.ts:186](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L186) ___ @@ -278,7 +278,7 @@ Returns the first [Entity](Entity.md) that matches this query. #### Defined in -[lib/search/search.ts:231](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L231) +[lib/search/search.ts:231](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L231) ___ @@ -298,7 +298,7 @@ Returns the first entity ID that matches this query. #### Defined in -[lib/search/search.ts:239](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L239) +[lib/search/search.ts:239](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L239) ___ @@ -318,7 +318,7 @@ Returns the first key name that matches this query. #### Defined in -[lib/search/search.ts:247](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L247) +[lib/search/search.ts:247](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L247) ___ @@ -346,7 +346,7 @@ The entity ID [Entity](Entity.md) with the maximal value #### Defined in -[lib/search/search.ts:159](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L159) +[lib/search/search.ts:159](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L159) ___ @@ -374,7 +374,7 @@ The entity ID with the maximal value #### Defined in -[lib/search/search.ts:168](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L168) +[lib/search/search.ts:168](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L168) ___ @@ -402,7 +402,7 @@ The key name with the maximal value #### Defined in -[lib/search/search.ts:178](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L178) +[lib/search/search.ts:178](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L178) ___ @@ -430,7 +430,7 @@ The [Entity](Entity.md) with the minimal value #### Defined in -[lib/search/search.ts:131](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L131) +[lib/search/search.ts:131](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L131) ___ @@ -458,7 +458,7 @@ The entity ID with the minimal value #### Defined in -[lib/search/search.ts:140](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L140) +[lib/search/search.ts:140](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L140) ___ @@ -486,7 +486,7 @@ The key name with the minimal value #### Defined in -[lib/search/search.ts:150](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L150) +[lib/search/search.ts:150](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L150) ___ @@ -510,7 +510,7 @@ A subclass of [WhereField](WhereField.md) matching the type of the field. #### Defined in -[lib/search/search.ts:559](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L559) +[lib/search/search.ts:559](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L559) ▸ **or**(`subSearchFn`): [`Search`](Search.md)<`TEntity`\> @@ -530,7 +530,7 @@ Sets up a nested search as a logical OR. #### Defined in -[lib/search/search.ts:566](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L566) +[lib/search/search.ts:566](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L566) ___ @@ -559,7 +559,7 @@ An array of [Entities](Entity.md) matching the query. #### Defined in -[lib/search/search.ts:199](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L199) +[lib/search/search.ts:199](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L199) ___ @@ -588,7 +588,7 @@ An array of strings matching the query. #### Defined in -[lib/search/search.ts:212](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L212) +[lib/search/search.ts:212](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L212) ___ @@ -617,7 +617,7 @@ An array of strings matching the query. #### Defined in -[lib/search/search.ts:223](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L223) +[lib/search/search.ts:223](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L223) ___ @@ -644,7 +644,7 @@ Alias for [Search.all](Search.md#all). #### Defined in -[lib/search/search.ts:431](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L431) +[lib/search/search.ts:431](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L431) ___ @@ -671,7 +671,7 @@ Alias for [Search.allIds](Search.md#allids). #### Defined in -[lib/search/search.ts:438](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L438) +[lib/search/search.ts:438](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L438) ___ @@ -698,7 +698,7 @@ Alias for [Search.allKeys](Search.md#allkeys). #### Defined in -[lib/search/search.ts:445](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L445) +[lib/search/search.ts:445](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L445) ___ @@ -718,7 +718,7 @@ Alias for [Search.count](Search.md#count). #### Defined in -[lib/search/search.ts:382](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L382) +[lib/search/search.ts:382](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L382) ___ @@ -738,7 +738,7 @@ Alias for [Search.first](Search.md#first). #### Defined in -[lib/search/search.ts:410](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L410) +[lib/search/search.ts:410](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L410) ___ @@ -758,7 +758,7 @@ Alias for [Search.firstId](Search.md#firstid). #### Defined in -[lib/search/search.ts:417](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L417) +[lib/search/search.ts:417](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L417) ___ @@ -778,7 +778,7 @@ Alias for [Search.firstKey](Search.md#firstkey). #### Defined in -[lib/search/search.ts:424](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L424) +[lib/search/search.ts:424](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L424) ___ @@ -804,7 +804,7 @@ Alias for [Search.max](Search.md#max). #### Defined in -[lib/search/search.ts:361](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L361) +[lib/search/search.ts:361](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L361) ___ @@ -830,7 +830,7 @@ Alias for [Search.maxId](Search.md#maxid). #### Defined in -[lib/search/search.ts:368](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L368) +[lib/search/search.ts:368](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L368) ___ @@ -856,7 +856,7 @@ Alias for [Search.maxKey](Search.md#maxkey). #### Defined in -[lib/search/search.ts:375](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L375) +[lib/search/search.ts:375](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L375) ___ @@ -882,7 +882,7 @@ Alias for [Search.min](Search.md#min). #### Defined in -[lib/search/search.ts:340](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L340) +[lib/search/search.ts:340](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L340) ___ @@ -908,7 +908,7 @@ Alias for [Search.minId](Search.md#minid). #### Defined in -[lib/search/search.ts:347](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L347) +[lib/search/search.ts:347](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L347) ___ @@ -934,7 +934,7 @@ Alias for [Search.minKey](Search.md#minkey). #### Defined in -[lib/search/search.ts:354](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L354) +[lib/search/search.ts:354](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L354) ___ @@ -961,7 +961,7 @@ Alias for [Search.page](Search.md#page). #### Defined in -[lib/search/search.ts:389](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L389) +[lib/search/search.ts:389](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L389) ___ @@ -988,7 +988,7 @@ Alias for [Search.pageOfIds](Search.md#pageofids). #### Defined in -[lib/search/search.ts:396](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L396) +[lib/search/search.ts:396](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L396) ___ @@ -1015,7 +1015,7 @@ Alias for {@link Search.pageOrKeys}. #### Defined in -[lib/search/search.ts:403](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L403) +[lib/search/search.ts:403](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L403) ___ @@ -1041,7 +1041,7 @@ Alias for [Search.sortAscending](Search.md#sortascending). #### Defined in -[lib/search/search.ts:83](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L83) +[lib/search/search.ts:83](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L83) ___ @@ -1069,7 +1069,7 @@ this #### Defined in -[lib/search/search.ts:60](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L60) +[lib/search/search.ts:60](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L60) ___ @@ -1098,7 +1098,7 @@ this #### Defined in -[lib/search/search.ts:93](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L93) +[lib/search/search.ts:93](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L93) ___ @@ -1124,7 +1124,7 @@ Alias for [Search.sortDescending](Search.md#sortdescending). #### Defined in -[lib/search/search.ts:67](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L67) +[lib/search/search.ts:67](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L67) ___ @@ -1152,7 +1152,7 @@ this #### Defined in -[lib/search/search.ts:76](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L76) +[lib/search/search.ts:76](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L76) ___ @@ -1177,7 +1177,7 @@ A subclass of [WhereField](WhereField.md) matching the type of the field. #### Defined in -[lib/search/search.ts:524](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L524) +[lib/search/search.ts:524](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L524) ▸ **where**(`subSearchFn`): [`Search`](Search.md)<`TEntity`\> @@ -1198,4 +1198,4 @@ they are treated logically as AND. #### Defined in -[lib/search/search.ts:532](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L532) +[lib/search/search.ts:532](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L532) diff --git a/docs/classes/Where.md b/docs/classes/Where.md index 94fb9292..71155fcb 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/47d4d36/lib/search/where.ts#L8) +[lib/search/where.ts:8](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/where.ts#L8) diff --git a/docs/classes/WhereField.md b/docs/classes/WhereField.md index d1609e1d..490f205c 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/47d4d36/lib/search/where-field.ts#L92) +[lib/search/where-field.ts:92](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L99) +[lib/search/where-field.ts:99](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L289) +[lib/search/where-field.ts:289](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L281) +[lib/search/where-field.ts:281](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L298) +[lib/search/where-field.ts:298](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L240) +[lib/search/where-field.ts:240](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L233) +[lib/search/where-field.ts:233](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L175) +[lib/search/where-field.ts:175](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L182) +[lib/search/where-field.ts:182](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L197) +[lib/search/where-field.ts:197](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L189) +[lib/search/where-field.ts:189](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L205) +[lib/search/where-field.ts:205](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L20) +[lib/search/where-field.ts:20](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L30) +[lib/search/where-field.ts:30](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L50) +[lib/search/where-field.ts:50](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L40) +[lib/search/where-field.ts:40](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L111) +[lib/search/where-field.ts:111](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L125) +[lib/search/where-field.ts:125](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L139) +[lib/search/where-field.ts:139](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L118) +[lib/search/where-field.ts:118](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L132) +[lib/search/where-field.ts:132](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L212) +[lib/search/where-field.ts:212](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L219) +[lib/search/where-field.ts:219](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L153) +[lib/search/where-field.ts:153](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L167) +[lib/search/where-field.ts:167](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L146) +[lib/search/where-field.ts:146](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L160) +[lib/search/where-field.ts:160](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L57) +[lib/search/where-field.ts:57](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L71) +[lib/search/where-field.ts:71](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L78) +[lib/search/where-field.ts:78](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L64) +[lib/search/where-field.ts:64](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L85) +[lib/search/where-field.ts:85](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L226) +[lib/search/where-field.ts:226](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L254) +[lib/search/where-field.ts:254](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L247) +[lib/search/where-field.ts:247](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L303) +[lib/search/where-field.ts:303](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/search/where-field.ts#L105) +[lib/search/where-field.ts:105](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/where-field.ts#L105) diff --git a/docs/interfaces/BaseFieldDefinition.md b/docs/interfaces/BaseFieldDefinition.md index 48448abc..2ab2d0c9 100644 --- a/docs/interfaces/BaseFieldDefinition.md +++ b/docs/interfaces/BaseFieldDefinition.md @@ -41,7 +41,7 @@ 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/47d4d36/lib/schema/definition/base-field-definition.ts#L12) +[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/base-field-definition.ts#L12) ___ @@ -54,7 +54,7 @@ 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/47d4d36/lib/schema/definition/base-field-definition.ts#L18) +[lib/schema/definition/base-field-definition.ts:18](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/base-field-definition.ts#L18) ___ @@ -66,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/47d4d36/lib/schema/definition/base-field-definition.ts#L6) +[lib/schema/definition/base-field-definition.ts:6](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/base-field-definition.ts#L6) diff --git a/docs/interfaces/BooleanFieldDefinition.md b/docs/interfaces/BooleanFieldDefinition.md index 0c480ea2..03a6d6c5 100644 --- a/docs/interfaces/BooleanFieldDefinition.md +++ b/docs/interfaces/BooleanFieldDefinition.md @@ -36,7 +36,7 @@ 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/47d4d36/lib/schema/definition/base-field-definition.ts#L12) +[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/base-field-definition.ts#L12) ___ @@ -53,7 +53,7 @@ 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/47d4d36/lib/schema/definition/base-field-definition.ts#L18) +[lib/schema/definition/base-field-definition.ts:18](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/base-field-definition.ts#L18) ___ @@ -69,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/47d4d36/lib/schema/definition/sortable-field-definition.ts#L4) +[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/sortable-field-definition.ts#L4) ___ @@ -85,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/47d4d36/lib/schema/definition/boolean-field-definition.ts#L7) +[lib/schema/definition/boolean-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/boolean-field-definition.ts#L7) diff --git a/docs/interfaces/CaseSensitiveFieldDefinition.md b/docs/interfaces/CaseSensitiveFieldDefinition.md index 565bd330..f6df79e8 100644 --- a/docs/interfaces/CaseSensitiveFieldDefinition.md +++ b/docs/interfaces/CaseSensitiveFieldDefinition.md @@ -29,4 +29,4 @@ to false. #### Defined in -[lib/schema/definition/casesensitive-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/definition/casesensitive-field-definition.ts#L7) +[lib/schema/definition/casesensitive-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/casesensitive-field-definition.ts#L7) diff --git a/docs/interfaces/DateFieldDefinition.md b/docs/interfaces/DateFieldDefinition.md index 9524ed01..a2cd8a40 100644 --- a/docs/interfaces/DateFieldDefinition.md +++ b/docs/interfaces/DateFieldDefinition.md @@ -36,7 +36,7 @@ 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/47d4d36/lib/schema/definition/base-field-definition.ts#L12) +[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/base-field-definition.ts#L12) ___ @@ -53,7 +53,7 @@ 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/47d4d36/lib/schema/definition/base-field-definition.ts#L18) +[lib/schema/definition/base-field-definition.ts:18](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/base-field-definition.ts#L18) ___ @@ -69,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/47d4d36/lib/schema/definition/sortable-field-definition.ts#L4) +[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/sortable-field-definition.ts#L4) ___ @@ -85,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/47d4d36/lib/schema/definition/date-field-definition.ts#L7) +[lib/schema/definition/date-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/date-field-definition.ts#L7) diff --git a/docs/interfaces/NormalizedFieldDefinition.md b/docs/interfaces/NormalizedFieldDefinition.md index 8e5b820d..c202a226 100644 --- a/docs/interfaces/NormalizedFieldDefinition.md +++ b/docs/interfaces/NormalizedFieldDefinition.md @@ -31,4 +31,4 @@ to true. #### Defined in -[lib/schema/definition/normalized-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/definition/normalized-field-definition.ts#L7) +[lib/schema/definition/normalized-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/normalized-field-definition.ts#L7) diff --git a/docs/interfaces/NumberFieldDefinition.md b/docs/interfaces/NumberFieldDefinition.md index f9d478fe..4f2c2d0a 100644 --- a/docs/interfaces/NumberFieldDefinition.md +++ b/docs/interfaces/NumberFieldDefinition.md @@ -36,7 +36,7 @@ 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/47d4d36/lib/schema/definition/base-field-definition.ts#L12) +[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/base-field-definition.ts#L12) ___ @@ -53,7 +53,7 @@ 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/47d4d36/lib/schema/definition/base-field-definition.ts#L18) +[lib/schema/definition/base-field-definition.ts:18](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/base-field-definition.ts#L18) ___ @@ -69,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/47d4d36/lib/schema/definition/sortable-field-definition.ts#L4) +[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/sortable-field-definition.ts#L4) ___ @@ -85,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/47d4d36/lib/schema/definition/number-field-definition.ts#L7) +[lib/schema/definition/number-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/number-field-definition.ts#L7) diff --git a/docs/interfaces/PhoneticFieldDefinition.md b/docs/interfaces/PhoneticFieldDefinition.md index 3e27cb65..a8eb0b9f 100644 --- a/docs/interfaces/PhoneticFieldDefinition.md +++ b/docs/interfaces/PhoneticFieldDefinition.md @@ -30,4 +30,4 @@ dm:es - Double Metaphone for Spanish #### Defined in -[lib/schema/definition/phonetic-field-definition.ts:10](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/definition/phonetic-field-definition.ts#L10) +[lib/schema/definition/phonetic-field-definition.ts:10](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/phonetic-field-definition.ts#L10) diff --git a/docs/interfaces/PointFieldDefinition.md b/docs/interfaces/PointFieldDefinition.md index 126ba016..32e76b9e 100644 --- a/docs/interfaces/PointFieldDefinition.md +++ b/docs/interfaces/PointFieldDefinition.md @@ -33,7 +33,7 @@ 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/47d4d36/lib/schema/definition/base-field-definition.ts#L12) +[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/base-field-definition.ts#L12) ___ @@ -50,7 +50,7 @@ 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/47d4d36/lib/schema/definition/base-field-definition.ts#L18) +[lib/schema/definition/base-field-definition.ts:18](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/base-field-definition.ts#L18) ___ @@ -66,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/47d4d36/lib/schema/definition/point-field-definition.ts#L6) +[lib/schema/definition/point-field-definition.ts:6](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/point-field-definition.ts#L6) diff --git a/docs/interfaces/SeparableFieldDefinition.md b/docs/interfaces/SeparableFieldDefinition.md index 97f75519..a515e733 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/47d4d36/lib/schema/definition/separable-field-definition.ts#L9) +[lib/schema/definition/separable-field-definition.ts:9](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/separable-field-definition.ts#L9) diff --git a/docs/interfaces/SortableFieldDefinition.md b/docs/interfaces/SortableFieldDefinition.md index 6078b9be..1804b0ad 100644 --- a/docs/interfaces/SortableFieldDefinition.md +++ b/docs/interfaces/SortableFieldDefinition.md @@ -36,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/47d4d36/lib/schema/definition/sortable-field-definition.ts#L4) +[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/sortable-field-definition.ts#L4) diff --git a/docs/interfaces/StemmingFieldDefinition.md b/docs/interfaces/StemmingFieldDefinition.md index 4026ae02..e2d04341 100644 --- a/docs/interfaces/StemmingFieldDefinition.md +++ b/docs/interfaces/StemmingFieldDefinition.md @@ -27,4 +27,4 @@ to true. #### Defined in -[lib/schema/definition/stemming-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/definition/stemming-field-definition.ts#L7) +[lib/schema/definition/stemming-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/stemming-field-definition.ts#L7) diff --git a/docs/interfaces/StringArrayFieldDefinition.md b/docs/interfaces/StringArrayFieldDefinition.md index 1a70ebc5..53e66b25 100644 --- a/docs/interfaces/StringArrayFieldDefinition.md +++ b/docs/interfaces/StringArrayFieldDefinition.md @@ -45,7 +45,7 @@ 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/47d4d36/lib/schema/definition/base-field-definition.ts#L12) +[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/base-field-definition.ts#L12) ___ @@ -62,7 +62,7 @@ to false. #### Defined in -[lib/schema/definition/casesensitive-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/definition/casesensitive-field-definition.ts#L7) +[lib/schema/definition/casesensitive-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/casesensitive-field-definition.ts#L7) ___ @@ -79,7 +79,7 @@ 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/47d4d36/lib/schema/definition/base-field-definition.ts#L18) +[lib/schema/definition/base-field-definition.ts:18](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/base-field-definition.ts#L18) ___ @@ -96,7 +96,7 @@ to true. #### Defined in -[lib/schema/definition/normalized-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/definition/normalized-field-definition.ts#L7) +[lib/schema/definition/normalized-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/normalized-field-definition.ts#L7) ___ @@ -115,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/47d4d36/lib/schema/definition/separable-field-definition.ts#L9) +[lib/schema/definition/separable-field-definition.ts:9](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/separable-field-definition.ts#L9) ___ @@ -131,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/47d4d36/lib/schema/definition/sortable-field-definition.ts#L4) +[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/sortable-field-definition.ts#L4) ___ @@ -147,4 +147,4 @@ Yep. It's a string array. #### Defined in -[lib/schema/definition/string-array-field-definition.ts:10](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/definition/string-array-field-definition.ts#L10) +[lib/schema/definition/string-array-field-definition.ts:10](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/string-array-field-definition.ts#L10) diff --git a/docs/interfaces/StringFieldDefinition.md b/docs/interfaces/StringFieldDefinition.md index d8801564..75353b7c 100644 --- a/docs/interfaces/StringFieldDefinition.md +++ b/docs/interfaces/StringFieldDefinition.md @@ -45,7 +45,7 @@ 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/47d4d36/lib/schema/definition/base-field-definition.ts#L12) +[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/base-field-definition.ts#L12) ___ @@ -62,7 +62,7 @@ to false. #### Defined in -[lib/schema/definition/casesensitive-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/definition/casesensitive-field-definition.ts#L7) +[lib/schema/definition/casesensitive-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/casesensitive-field-definition.ts#L7) ___ @@ -79,7 +79,7 @@ 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/47d4d36/lib/schema/definition/base-field-definition.ts#L18) +[lib/schema/definition/base-field-definition.ts:18](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/base-field-definition.ts#L18) ___ @@ -96,7 +96,7 @@ to true. #### Defined in -[lib/schema/definition/normalized-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/definition/normalized-field-definition.ts#L7) +[lib/schema/definition/normalized-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/normalized-field-definition.ts#L7) ___ @@ -115,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/47d4d36/lib/schema/definition/separable-field-definition.ts#L9) +[lib/schema/definition/separable-field-definition.ts:9](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/separable-field-definition.ts#L9) ___ @@ -131,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/47d4d36/lib/schema/definition/sortable-field-definition.ts#L4) +[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/sortable-field-definition.ts#L4) ___ @@ -147,4 +147,4 @@ Yep. It's a string. #### Defined in -[lib/schema/definition/string-field-definition.ts:10](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/definition/string-field-definition.ts#L10) +[lib/schema/definition/string-field-definition.ts:10](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/string-field-definition.ts#L10) diff --git a/docs/interfaces/TextFieldDefinition.md b/docs/interfaces/TextFieldDefinition.md index 83f81b2f..55e06af9 100644 --- a/docs/interfaces/TextFieldDefinition.md +++ b/docs/interfaces/TextFieldDefinition.md @@ -48,7 +48,7 @@ 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/47d4d36/lib/schema/definition/base-field-definition.ts#L12) +[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/base-field-definition.ts#L12) ___ @@ -65,7 +65,7 @@ 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/47d4d36/lib/schema/definition/base-field-definition.ts#L18) +[lib/schema/definition/base-field-definition.ts:18](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/base-field-definition.ts#L18) ___ @@ -85,7 +85,7 @@ dm:es - Double Metaphone for Spanish #### Defined in -[lib/schema/definition/phonetic-field-definition.ts:10](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/definition/phonetic-field-definition.ts#L10) +[lib/schema/definition/phonetic-field-definition.ts:10](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/phonetic-field-definition.ts#L10) ___ @@ -102,7 +102,7 @@ to true. #### Defined in -[lib/schema/definition/normalized-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/definition/normalized-field-definition.ts#L7) +[lib/schema/definition/normalized-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/normalized-field-definition.ts#L7) ___ @@ -118,7 +118,7 @@ Enables sorting by this field. #### Defined in -[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/definition/sortable-field-definition.ts#L4) +[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/sortable-field-definition.ts#L4) ___ @@ -135,7 +135,7 @@ to true. #### Defined in -[lib/schema/definition/stemming-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/definition/stemming-field-definition.ts#L7) +[lib/schema/definition/stemming-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/stemming-field-definition.ts#L7) ___ @@ -151,7 +151,7 @@ Yep. It's searchable text. #### Defined in -[lib/schema/definition/text-field-definition.ts:11](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/definition/text-field-definition.ts#L11) +[lib/schema/definition/text-field-definition.ts:11](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/text-field-definition.ts#L11) ___ @@ -167,4 +167,4 @@ 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/47d4d36/lib/schema/definition/weight-field-definition.ts#L4) +[lib/schema/definition/weight-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/weight-field-definition.ts#L4) diff --git a/docs/interfaces/WeightFieldDefinition.md b/docs/interfaces/WeightFieldDefinition.md index fd9b3fcb..45ca382c 100644 --- a/docs/interfaces/WeightFieldDefinition.md +++ b/docs/interfaces/WeightFieldDefinition.md @@ -26,4 +26,4 @@ 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/47d4d36/lib/schema/definition/weight-field-definition.ts#L4) +[lib/schema/definition/weight-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/schema/definition/weight-field-definition.ts#L4)