diff --git a/CHANGELOG b/CHANGELOG index de327736..88ae7e52 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -4,6 +4,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and Redis OM adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## 0.4.3 - 2023-10-30 +### Fixed +- Fixed issue with change of casing in error message in RediSearch when calling `.dropIndex` on *Repository* + +### Added +- Add `.expireAt` method to *Repository* +- Add fuzz matching for 'text' type + ## 0.4.2 - 2023-07-26 ### Fixed - Fixed issue with TAGs not properl;y escaping question marks diff --git a/docs/README.md b/docs/README.md index 4eeab099..2b58e1ed 100644 --- a/docs/README.md +++ b/docs/README.md @@ -94,7 +94,7 @@ All configuration properties that any field might have, regardless of type. #### Defined in -[lib/schema/definitions.ts:5](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/definitions.ts#L5) +[lib/schema/definitions.ts:5](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/definitions.ts#L5) ___ @@ -106,7 +106,7 @@ A field representing a boolean. #### Defined in -[lib/schema/definitions.ts:78](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/definitions.ts#L78) +[lib/schema/definitions.ts:78](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/definitions.ts#L78) ___ @@ -132,7 +132,7 @@ A function that defines a circle for `.inCircle` searches. #### Defined in -[lib/search/where-point.ts:8](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-point.ts#L8) +[lib/search/where-point.ts:8](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L8) ___ @@ -144,7 +144,7 @@ The configuration properties that all fields have in common. #### Defined in -[lib/schema/definitions.ts:75](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/definitions.ts#L75) +[lib/schema/definitions.ts:75](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/definitions.ts#L75) ___ @@ -156,7 +156,7 @@ The type of data structure in Redis to map objects to. #### Defined in -[lib/schema/options.ts:2](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/options.ts#L2) +[lib/schema/options.ts:2](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/options.ts#L2) ___ @@ -168,7 +168,7 @@ A field representing a date/time. #### Defined in -[lib/schema/definitions.ts:83](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/definitions.ts#L83) +[lib/schema/definitions.ts:83](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/definitions.ts#L83) ___ @@ -180,7 +180,7 @@ Defines the objects returned from calls to [repositories](classes/Repository.md) #### Defined in -[lib/entity/entity.ts:8](https://github.com/redis/redis-om-node/blob/4f5798b/lib/entity/entity.ts#L8) +[lib/entity/entity.ts:8](https://github.com/redis/redis-om-node/blob/d8438f7/lib/entity/entity.ts#L8) ___ @@ -196,7 +196,7 @@ The free-form data associated with an [Entity](README.md#entity). #### Defined in -[lib/entity/entity.ts:18](https://github.com/redis/redis-om-node/blob/4f5798b/lib/entity/entity.ts#L18) +[lib/entity/entity.ts:18](https://github.com/redis/redis-om-node/blob/d8438f7/lib/entity/entity.ts#L18) ___ @@ -208,7 +208,7 @@ Valid types for values in an [Entity](README.md#entity). #### Defined in -[lib/entity/entity.ts:23](https://github.com/redis/redis-om-node/blob/4f5798b/lib/entity/entity.ts#L23) +[lib/entity/entity.ts:23](https://github.com/redis/redis-om-node/blob/d8438f7/lib/entity/entity.ts#L23) ___ @@ -220,7 +220,7 @@ Contains instructions telling how to map a property on an [Entity](README.md#ent #### Defined in -[lib/schema/definitions.ts:117](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/definitions.ts#L117) +[lib/schema/definitions.ts:117](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/definitions.ts#L117) ___ @@ -232,7 +232,7 @@ Valid field types for a [FieldDefinition](README.md#fielddefinition). #### Defined in -[lib/schema/definitions.ts:2](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/definitions.ts#L2) +[lib/schema/definitions.ts:2](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/definitions.ts#L2) ___ @@ -252,7 +252,7 @@ A function that generates random entityIds. #### Defined in -[lib/schema/options.ts:5](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/options.ts#L5) +[lib/schema/options.ts:5](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/options.ts#L5) ___ @@ -264,7 +264,7 @@ A field representing an array of numbers. #### Defined in -[lib/schema/definitions.ts:93](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/definitions.ts#L93) +[lib/schema/definitions.ts:93](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/definitions.ts#L93) ___ @@ -276,7 +276,7 @@ A field representing a number. #### Defined in -[lib/schema/definitions.ts:88](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/definitions.ts#L88) +[lib/schema/definitions.ts:88](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/definitions.ts#L88) ___ @@ -295,7 +295,7 @@ Defines a point on the globe using longitude and latitude. #### Defined in -[lib/entity/entity.ts:26](https://github.com/redis/redis-om-node/blob/4f5798b/lib/entity/entity.ts#L26) +[lib/entity/entity.ts:26](https://github.com/redis/redis-om-node/blob/d8438f7/lib/entity/entity.ts#L26) ___ @@ -307,7 +307,7 @@ A field representing a point on the globe. #### Defined in -[lib/schema/definitions.ts:98](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/definitions.ts#L98) +[lib/schema/definitions.ts:98](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/definitions.ts#L98) ___ @@ -319,7 +319,7 @@ A conventional Redis connection. #### Defined in -[lib/client/client.ts:8](https://github.com/redis/redis-om-node/blob/4f5798b/lib/client/client.ts#L8) +[lib/client/client.ts:8](https://github.com/redis/redis-om-node/blob/d8438f7/lib/client/client.ts#L8) ___ @@ -331,7 +331,7 @@ A clustered Redis connection. #### Defined in -[lib/client/client.ts:11](https://github.com/redis/redis-om-node/blob/4f5798b/lib/client/client.ts#L11) +[lib/client/client.ts:11](https://github.com/redis/redis-om-node/blob/d8438f7/lib/client/client.ts#L11) ___ @@ -343,7 +343,7 @@ A Redis connection, clustered or conventional. #### Defined in -[lib/client/client.ts:14](https://github.com/redis/redis-om-node/blob/4f5798b/lib/client/client.ts#L14) +[lib/client/client.ts:14](https://github.com/redis/redis-om-node/blob/d8438f7/lib/client/client.ts#L14) ___ @@ -355,7 +355,7 @@ Group of [FieldDefinition](README.md#fielddefinition)s that define the schema fo #### Defined in -[lib/schema/definitions.ts:123](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/definitions.ts#L123) +[lib/schema/definitions.ts:123](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/definitions.ts#L123) ___ @@ -378,7 +378,7 @@ Configuration options for a [Schema](classes/Schema.md). #### Defined in -[lib/schema/options.ts:11](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/options.ts#L11) +[lib/schema/options.ts:11](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/options.ts#L11) ___ @@ -390,7 +390,7 @@ Valid values for how to use stop words for a given [Schema](classes/Schema.md). #### Defined in -[lib/schema/options.ts:8](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/options.ts#L8) +[lib/schema/options.ts:8](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/options.ts#L8) ___ @@ -402,7 +402,7 @@ A field representing an array of strings. #### Defined in -[lib/schema/definitions.ts:107](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/definitions.ts#L107) +[lib/schema/definitions.ts:107](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/definitions.ts#L107) ___ @@ -414,7 +414,7 @@ A field representing a whole string. #### Defined in -[lib/schema/definitions.ts:102](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/definitions.ts#L102) +[lib/schema/definitions.ts:102](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/definitions.ts#L102) ___ @@ -440,7 +440,7 @@ A function that takes a [Search](classes/Search.md) and returns a [Search](class #### Defined in -[lib/search/search.ts:26](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L26) +[lib/search/search.ts:26](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L26) ___ @@ -452,7 +452,7 @@ A field representing searchable text. #### Defined in -[lib/schema/definitions.ts:112](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/definitions.ts#L112) +[lib/schema/definitions.ts:112](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/definitions.ts#L112) ## Variables @@ -464,7 +464,7 @@ The Symbol used to access the entity ID of an [Entity](README.md#entity). #### Defined in -[lib/entity/entity.ts:2](https://github.com/redis/redis-om-node/blob/4f5798b/lib/entity/entity.ts#L2) +[lib/entity/entity.ts:2](https://github.com/redis/redis-om-node/blob/d8438f7/lib/entity/entity.ts#L2) ___ @@ -476,4 +476,4 @@ The Symbol used to access the keyname of an [Entity](README.md#entity). #### Defined in -[lib/entity/entity.ts:5](https://github.com/redis/redis-om-node/blob/4f5798b/lib/entity/entity.ts#L5) +[lib/entity/entity.ts:5](https://github.com/redis/redis-om-node/blob/d8438f7/lib/entity/entity.ts#L5) diff --git a/docs/classes/AbstractSearch.md b/docs/classes/AbstractSearch.md index a68ed452..78bf63c7 100644 --- a/docs/classes/AbstractSearch.md +++ b/docs/classes/AbstractSearch.md @@ -79,7 +79,7 @@ this #### Defined in -[lib/search/search.ts:308](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L308) +[lib/search/search.ts:308](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L308) ## Methods @@ -111,7 +111,7 @@ An array of [Entities](../README.md#entity) matching the query. #### Defined in -[lib/search/search.ts:264](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L264) +[lib/search/search.ts:264](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L264) ___ @@ -143,7 +143,7 @@ An array of entity IDs matching the query. #### Defined in -[lib/search/search.ts:282](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L282) +[lib/search/search.ts:282](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L282) ___ @@ -175,7 +175,7 @@ An array of key names matching the query. #### Defined in -[lib/search/search.ts:300](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L300) +[lib/search/search.ts:300](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L300) ___ @@ -191,7 +191,7 @@ Returns the number of [Entities](../README.md#entity) that match this query. #### Defined in -[lib/search/search.ts:188](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L188) +[lib/search/search.ts:188](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L188) ___ @@ -207,7 +207,7 @@ Returns the first [Entity](../README.md#entity) that matches this query. #### Defined in -[lib/search/search.ts:229](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L229) +[lib/search/search.ts:229](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L229) ___ @@ -223,7 +223,7 @@ Returns the first entity ID that matches this query. #### Defined in -[lib/search/search.ts:237](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L237) +[lib/search/search.ts:237](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L237) ___ @@ -239,7 +239,7 @@ Returns the first key name that matches this query. #### Defined in -[lib/search/search.ts:245](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L245) +[lib/search/search.ts:245](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L245) ___ @@ -263,7 +263,7 @@ The entity ID [Entity](../README.md#entity) with the maximal value #### Defined in -[lib/search/search.ts:162](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L162) +[lib/search/search.ts:162](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L162) ___ @@ -287,7 +287,7 @@ The entity ID with the maximal value #### Defined in -[lib/search/search.ts:171](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L171) +[lib/search/search.ts:171](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L171) ___ @@ -311,7 +311,7 @@ The key name with the maximal value #### Defined in -[lib/search/search.ts:180](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L180) +[lib/search/search.ts:180](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L180) ___ @@ -335,7 +335,7 @@ The [Entity](../README.md#entity) with the minimal value #### Defined in -[lib/search/search.ts:135](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L135) +[lib/search/search.ts:135](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L135) ___ @@ -359,7 +359,7 @@ The entity ID with the minimal value #### Defined in -[lib/search/search.ts:144](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L144) +[lib/search/search.ts:144](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L144) ___ @@ -383,7 +383,7 @@ The key name with the minimal value #### Defined in -[lib/search/search.ts:153](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L153) +[lib/search/search.ts:153](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L153) ___ @@ -408,7 +408,7 @@ An array of [Entities](../README.md#entity) matching the query. #### Defined in -[lib/search/search.ts:199](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L199) +[lib/search/search.ts:199](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L199) ___ @@ -433,7 +433,7 @@ An array of strings matching the query. #### Defined in -[lib/search/search.ts:210](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L210) +[lib/search/search.ts:210](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L210) ___ @@ -458,7 +458,7 @@ An array of strings matching the query. #### Defined in -[lib/search/search.ts:221](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L221) +[lib/search/search.ts:221](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L221) ___ @@ -481,7 +481,7 @@ Alias for [all](Search.md#all). #### Defined in -[lib/search/search.ts:406](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L406) +[lib/search/search.ts:406](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L406) ___ @@ -504,7 +504,7 @@ Alias for [allIds](Search.md#allids). #### Defined in -[lib/search/search.ts:413](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L413) +[lib/search/search.ts:413](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L413) ___ @@ -527,7 +527,7 @@ Alias for [allKeys](Search.md#allkeys). #### Defined in -[lib/search/search.ts:420](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L420) +[lib/search/search.ts:420](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L420) ___ @@ -543,7 +543,7 @@ Alias for [count](Search.md#count). #### Defined in -[lib/search/search.ts:357](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L357) +[lib/search/search.ts:357](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L357) ___ @@ -559,7 +559,7 @@ Alias for [first](Search.md#first). #### Defined in -[lib/search/search.ts:385](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L385) +[lib/search/search.ts:385](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L385) ___ @@ -575,7 +575,7 @@ Alias for [firstId](Search.md#firstid). #### Defined in -[lib/search/search.ts:392](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L392) +[lib/search/search.ts:392](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L392) ___ @@ -591,7 +591,7 @@ Alias for [firstKey](Search.md#firstkey). #### Defined in -[lib/search/search.ts:399](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L399) +[lib/search/search.ts:399](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L399) ___ @@ -613,7 +613,7 @@ Alias for [max](Search.md#max). #### Defined in -[lib/search/search.ts:336](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L336) +[lib/search/search.ts:336](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L336) ___ @@ -635,7 +635,7 @@ Alias for [maxId](Search.md#maxid). #### Defined in -[lib/search/search.ts:343](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L343) +[lib/search/search.ts:343](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L343) ___ @@ -657,7 +657,7 @@ Alias for [maxKey](Search.md#maxkey). #### Defined in -[lib/search/search.ts:350](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L350) +[lib/search/search.ts:350](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L350) ___ @@ -679,7 +679,7 @@ Alias for [min](Search.md#min). #### Defined in -[lib/search/search.ts:315](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L315) +[lib/search/search.ts:315](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L315) ___ @@ -701,7 +701,7 @@ Alias for [minId](Search.md#minid). #### Defined in -[lib/search/search.ts:322](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L322) +[lib/search/search.ts:322](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L322) ___ @@ -723,7 +723,7 @@ Alias for [minKey](Search.md#minkey). #### Defined in -[lib/search/search.ts:329](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L329) +[lib/search/search.ts:329](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L329) ___ @@ -746,7 +746,7 @@ Alias for [page](Search.md#page). #### Defined in -[lib/search/search.ts:364](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L364) +[lib/search/search.ts:364](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L364) ___ @@ -769,7 +769,7 @@ Alias for [pageOfIds](Search.md#pageofids). #### Defined in -[lib/search/search.ts:371](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L371) +[lib/search/search.ts:371](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L371) ___ @@ -792,7 +792,7 @@ Alias for [pageOfKeys](Search.md#pageofkeys). #### Defined in -[lib/search/search.ts:378](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L378) +[lib/search/search.ts:378](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L378) ___ @@ -814,7 +814,7 @@ Alias for [sortAscending](Search.md#sortascending). #### Defined in -[lib/search/search.ts:86](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L86) +[lib/search/search.ts:86](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L86) ___ @@ -838,7 +838,7 @@ this #### Defined in -[lib/search/search.ts:63](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L63) +[lib/search/search.ts:63](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L63) ___ @@ -863,7 +863,7 @@ this #### Defined in -[lib/search/search.ts:96](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L96) +[lib/search/search.ts:96](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L96) ___ @@ -885,7 +885,7 @@ Alias for [sortDescending](Search.md#sortdescending). #### Defined in -[lib/search/search.ts:70](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L70) +[lib/search/search.ts:70](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L70) ___ @@ -909,4 +909,4 @@ this #### Defined in -[lib/search/search.ts:79](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L79) +[lib/search/search.ts:79](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L79) diff --git a/docs/classes/ArrayHashInput.md b/docs/classes/ArrayHashInput.md index ffe1ffad..a3d4e360 100644 --- a/docs/classes/ArrayHashInput.md +++ b/docs/classes/ArrayHashInput.md @@ -49,7 +49,7 @@ #### Defined in -[lib/error/invalid-input.ts:67](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-input.ts#L67) +[lib/error/invalid-input.ts:67](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-input.ts#L67) ## Properties @@ -168,7 +168,7 @@ node_modules/@types/node/globals.d.ts:13 #### Defined in -[lib/error/invalid-input.ts:73](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-input.ts#L73) +[lib/error/invalid-input.ts:73](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-input.ts#L73) ## Methods diff --git a/docs/classes/Circle.md b/docs/classes/Circle.md index 41d1ac81..07781716 100644 --- a/docs/classes/Circle.md +++ b/docs/classes/Circle.md @@ -54,7 +54,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:149](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-point.ts#L149) +[lib/search/where-point.ts:149](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L149) ___ @@ -72,7 +72,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:143](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-point.ts#L143) +[lib/search/where-point.ts:143](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L143) ___ @@ -90,7 +90,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:137](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-point.ts#L137) +[lib/search/where-point.ts:137](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L137) ___ @@ -108,7 +108,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:122](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-point.ts#L122) +[lib/search/where-point.ts:122](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L122) ___ @@ -126,7 +126,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:128](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-point.ts#L128) +[lib/search/where-point.ts:128](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L128) ___ @@ -144,7 +144,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:116](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-point.ts#L116) +[lib/search/where-point.ts:116](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L116) ___ @@ -162,7 +162,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:95](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-point.ts#L95) +[lib/search/where-point.ts:95](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L95) ___ @@ -180,7 +180,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:101](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-point.ts#L101) +[lib/search/where-point.ts:101](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L101) ___ @@ -198,7 +198,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:107](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-point.ts#L107) +[lib/search/where-point.ts:107](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L107) ___ @@ -216,7 +216,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:158](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-point.ts#L158) +[lib/search/where-point.ts:158](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L158) ___ @@ -234,7 +234,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:164](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-point.ts#L164) +[lib/search/where-point.ts:164](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L164) ___ @@ -252,7 +252,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:170](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-point.ts#L170) +[lib/search/where-point.ts:170](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L170) ## Methods @@ -276,7 +276,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:42](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-point.ts#L42) +[lib/search/where-point.ts:42](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L42) ___ @@ -300,7 +300,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:31](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-point.ts#L31) +[lib/search/where-point.ts:31](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L31) ___ @@ -325,7 +325,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:54](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-point.ts#L54) +[lib/search/where-point.ts:54](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L54) ▸ **origin**(`longitude`, `latitude`): [`Circle`](Circle.md) @@ -347,7 +347,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:64](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-point.ts#L64) +[lib/search/where-point.ts:64](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L64) ___ @@ -372,4 +372,4 @@ This instance. #### Defined in -[lib/search/where-point.ts:86](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-point.ts#L86) +[lib/search/where-point.ts:86](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L86) diff --git a/docs/classes/Client.md b/docs/classes/Client.md index 2978560e..f4398c46 100644 --- a/docs/classes/Client.md +++ b/docs/classes/Client.md @@ -57,7 +57,7 @@ Returns the underlying Node Redis connection being used. #### Defined in -[lib/client/client.ts:70](https://github.com/redis/redis-om-node/blob/4f5798b/lib/client/client.ts#L70) +[lib/client/client.ts:70](https://github.com/redis/redis-om-node/blob/d8438f7/lib/client/client.ts#L70) ## Methods @@ -73,7 +73,7 @@ Close the connection to Redis. #### Defined in -[lib/client/client.ts:127](https://github.com/redis/redis-om-node/blob/4f5798b/lib/client/client.ts#L127) +[lib/client/client.ts:127](https://github.com/redis/redis-om-node/blob/d8438f7/lib/client/client.ts#L127) ___ @@ -97,7 +97,7 @@ A repository for the provided schema. #### Defined in -[lib/client/client.ts:119](https://github.com/redis/redis-om-node/blob/4f5798b/lib/client/client.ts#L119) +[lib/client/client.ts:119](https://github.com/redis/redis-om-node/blob/d8438f7/lib/client/client.ts#L119) ___ @@ -113,7 +113,7 @@ Whether a connection is already open. #### Defined in -[lib/client/client.ts:207](https://github.com/redis/redis-om-node/blob/4f5798b/lib/client/client.ts#L207) +[lib/client/client.ts:213](https://github.com/redis/redis-om-node/blob/d8438f7/lib/client/client.ts#L213) ___ @@ -137,7 +137,7 @@ This [Client](Client.md) instance. #### Defined in -[lib/client/client.ts:104](https://github.com/redis/redis-om-node/blob/4f5798b/lib/client/client.ts#L104) +[lib/client/client.ts:104](https://github.com/redis/redis-om-node/blob/d8438f7/lib/client/client.ts#L104) ___ @@ -162,7 +162,7 @@ This [Client](Client.md) instance. #### Defined in -[lib/client/client.ts:81](https://github.com/redis/redis-om-node/blob/4f5798b/lib/client/client.ts#L81) +[lib/client/client.ts:81](https://github.com/redis/redis-om-node/blob/d8438f7/lib/client/client.ts#L81) ___ @@ -187,4 +187,4 @@ This [Client](Client.md) instance. #### Defined in -[lib/client/client.ts:93](https://github.com/redis/redis-om-node/blob/4f5798b/lib/client/client.ts#L93) +[lib/client/client.ts:93](https://github.com/redis/redis-om-node/blob/d8438f7/lib/client/client.ts#L93) diff --git a/docs/classes/Field.md b/docs/classes/Field.md index 4d51d51e..ca1c9e7d 100644 --- a/docs/classes/Field.md +++ b/docs/classes/Field.md @@ -43,7 +43,7 @@ Creates a Field. #### Defined in -[lib/schema/field.ts:17](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/field.ts#L17) +[lib/schema/field.ts:17](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L17) ## Accessors @@ -59,7 +59,7 @@ The case-sensitivity of the field. #### Defined in -[lib/schema/field.ts:55](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/field.ts#L55) +[lib/schema/field.ts:55](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L55) ___ @@ -75,7 +75,7 @@ The field name used to store this [Field](Field.md) in a Hash. #### Defined in -[lib/schema/field.ts:33](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/field.ts#L33) +[lib/schema/field.ts:33](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L33) ___ @@ -91,7 +91,7 @@ Indicates the field as being indexed—and thus queryable—by RediSearch. #### Defined in -[lib/schema/field.ts:60](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/field.ts#L60) +[lib/schema/field.ts:60](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L60) ___ @@ -107,7 +107,7 @@ Is this type an array or not. #### Defined in -[lib/schema/field.ts:85](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/field.ts#L85) +[lib/schema/field.ts:85](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L85) ___ @@ -123,7 +123,7 @@ The JSONPath used to store this [Field](Field.md) in a JSON document. #### Defined in -[lib/schema/field.ts:38](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/field.ts#L38) +[lib/schema/field.ts:38](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L38) ___ @@ -139,7 +139,7 @@ The phonetic matcher for the field. #### Defined in -[lib/schema/field.ts:80](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/field.ts#L80) +[lib/schema/field.ts:80](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L80) ___ @@ -155,7 +155,7 @@ The name of the field. #### Defined in -[lib/schema/field.ts:23](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/field.ts#L23) +[lib/schema/field.ts:23](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L23) ___ @@ -171,7 +171,7 @@ Indicates that the field is normalized. Ignored if sortable is false. #### Defined in -[lib/schema/field.ts:70](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/field.ts#L70) +[lib/schema/field.ts:70](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L70) ___ @@ -187,7 +187,7 @@ The separator for string[] fields when stored in Hashes. #### Defined in -[lib/schema/field.ts:45](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/field.ts#L45) +[lib/schema/field.ts:45](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L45) ___ @@ -203,7 +203,7 @@ Indicates that the field as sortable. #### Defined in -[lib/schema/field.ts:50](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/field.ts#L50) +[lib/schema/field.ts:50](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L50) ___ @@ -219,7 +219,7 @@ Indicates that the field as indexed with stemming support. #### Defined in -[lib/schema/field.ts:65](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/field.ts#L65) +[lib/schema/field.ts:65](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L65) ___ @@ -235,7 +235,7 @@ The [type](../README.md#fieldtype) of the field. #### Defined in -[lib/schema/field.ts:28](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/field.ts#L28) +[lib/schema/field.ts:28](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L28) ___ @@ -251,4 +251,4 @@ The search weight of the field. #### Defined in -[lib/schema/field.ts:75](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/field.ts#L75) +[lib/schema/field.ts:75](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L75) diff --git a/docs/classes/FieldNotInSchema.md b/docs/classes/FieldNotInSchema.md index 5acf7e26..ff3bbee0 100644 --- a/docs/classes/FieldNotInSchema.md +++ b/docs/classes/FieldNotInSchema.md @@ -49,7 +49,7 @@ #### Defined in -[lib/error/search-error.ts:11](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/search-error.ts#L11) +[lib/error/search-error.ts:11](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/search-error.ts#L11) ## Properties @@ -168,7 +168,7 @@ node_modules/@types/node/globals.d.ts:13 #### Defined in -[lib/error/search-error.ts:16](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/search-error.ts#L16) +[lib/error/search-error.ts:16](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/search-error.ts#L16) ## Methods diff --git a/docs/classes/InvalidHashInput.md b/docs/classes/InvalidHashInput.md index a6db0f85..cf23de39 100644 --- a/docs/classes/InvalidHashInput.md +++ b/docs/classes/InvalidHashInput.md @@ -50,7 +50,7 @@ #### Defined in -[lib/error/invalid-input.ts:40](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-input.ts#L40) +[lib/error/invalid-input.ts:40](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-input.ts#L40) ## Properties @@ -169,7 +169,7 @@ node_modules/@types/node/globals.d.ts:13 #### Defined in -[lib/error/invalid-input.ts:46](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-input.ts#L46) +[lib/error/invalid-input.ts:46](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-input.ts#L46) ___ @@ -183,7 +183,7 @@ ___ #### Defined in -[lib/error/invalid-input.ts:47](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-input.ts#L47) +[lib/error/invalid-input.ts:47](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-input.ts#L47) ## Methods diff --git a/docs/classes/InvalidHashValue.md b/docs/classes/InvalidHashValue.md index 3c0390d5..0e565ac7 100644 --- a/docs/classes/InvalidHashValue.md +++ b/docs/classes/InvalidHashValue.md @@ -51,7 +51,7 @@ #### Defined in -[lib/error/invalid-value.ts:40](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-value.ts#L40) +[lib/error/invalid-value.ts:40](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-value.ts#L40) ## Properties @@ -170,7 +170,7 @@ node_modules/@types/node/globals.d.ts:13 #### Defined in -[lib/error/invalid-value.ts:46](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-value.ts#L46) +[lib/error/invalid-value.ts:46](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-value.ts#L46) ___ @@ -184,7 +184,7 @@ ___ #### Defined in -[lib/error/invalid-value.ts:47](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-value.ts#L47) +[lib/error/invalid-value.ts:47](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-value.ts#L47) ___ @@ -198,7 +198,7 @@ ___ #### Defined in -[lib/error/invalid-value.ts:48](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-value.ts#L48) +[lib/error/invalid-value.ts:48](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-value.ts#L48) ## Methods diff --git a/docs/classes/InvalidJsonInput.md b/docs/classes/InvalidJsonInput.md index 6b09ce66..fd96e448 100644 --- a/docs/classes/InvalidJsonInput.md +++ b/docs/classes/InvalidJsonInput.md @@ -51,7 +51,7 @@ #### Defined in -[lib/error/invalid-input.ts:25](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-input.ts#L25) +[lib/error/invalid-input.ts:25](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-input.ts#L25) ## Properties @@ -170,7 +170,7 @@ node_modules/@types/node/globals.d.ts:13 #### Defined in -[lib/error/invalid-input.ts:31](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-input.ts#L31) +[lib/error/invalid-input.ts:31](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-input.ts#L31) ___ @@ -184,7 +184,7 @@ ___ #### Defined in -[lib/error/invalid-input.ts:32](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-input.ts#L32) +[lib/error/invalid-input.ts:32](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-input.ts#L32) ___ @@ -198,7 +198,7 @@ ___ #### Defined in -[lib/error/invalid-input.ts:33](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-input.ts#L33) +[lib/error/invalid-input.ts:33](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-input.ts#L33) ## Methods diff --git a/docs/classes/InvalidJsonValue.md b/docs/classes/InvalidJsonValue.md index be8ebb02..ef42a575 100644 --- a/docs/classes/InvalidJsonValue.md +++ b/docs/classes/InvalidJsonValue.md @@ -51,7 +51,7 @@ #### Defined in -[lib/error/invalid-value.ts:25](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-value.ts#L25) +[lib/error/invalid-value.ts:25](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-value.ts#L25) ## Properties @@ -170,7 +170,7 @@ node_modules/@types/node/globals.d.ts:13 #### Defined in -[lib/error/invalid-value.ts:31](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-value.ts#L31) +[lib/error/invalid-value.ts:31](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-value.ts#L31) ___ @@ -184,7 +184,7 @@ ___ #### Defined in -[lib/error/invalid-value.ts:32](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-value.ts#L32) +[lib/error/invalid-value.ts:32](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-value.ts#L32) ___ @@ -198,7 +198,7 @@ ___ #### Defined in -[lib/error/invalid-value.ts:33](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-value.ts#L33) +[lib/error/invalid-value.ts:33](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-value.ts#L33) ## Methods diff --git a/docs/classes/NestedHashInput.md b/docs/classes/NestedHashInput.md index 63f4c05c..b31b0aa1 100644 --- a/docs/classes/NestedHashInput.md +++ b/docs/classes/NestedHashInput.md @@ -49,7 +49,7 @@ #### Defined in -[lib/error/invalid-input.ts:54](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-input.ts#L54) +[lib/error/invalid-input.ts:54](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-input.ts#L54) ## Properties @@ -168,7 +168,7 @@ node_modules/@types/node/globals.d.ts:13 #### Defined in -[lib/error/invalid-input.ts:60](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-input.ts#L60) +[lib/error/invalid-input.ts:60](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-input.ts#L60) ## Methods diff --git a/docs/classes/NullJsonInput.md b/docs/classes/NullJsonInput.md index e50a816a..e117a1bd 100644 --- a/docs/classes/NullJsonInput.md +++ b/docs/classes/NullJsonInput.md @@ -51,7 +51,7 @@ #### Defined in -[lib/error/invalid-input.ts:10](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-input.ts#L10) +[lib/error/invalid-input.ts:10](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-input.ts#L10) ## Properties @@ -170,7 +170,7 @@ node_modules/@types/node/globals.d.ts:13 #### Defined in -[lib/error/invalid-input.ts:16](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-input.ts#L16) +[lib/error/invalid-input.ts:16](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-input.ts#L16) ___ @@ -184,7 +184,7 @@ ___ #### Defined in -[lib/error/invalid-input.ts:17](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-input.ts#L17) +[lib/error/invalid-input.ts:17](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-input.ts#L17) ___ @@ -198,7 +198,7 @@ ___ #### Defined in -[lib/error/invalid-input.ts:18](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-input.ts#L18) +[lib/error/invalid-input.ts:18](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-input.ts#L18) ## Methods diff --git a/docs/classes/NullJsonValue.md b/docs/classes/NullJsonValue.md index 42c848a0..30538d72 100644 --- a/docs/classes/NullJsonValue.md +++ b/docs/classes/NullJsonValue.md @@ -51,7 +51,7 @@ #### Defined in -[lib/error/invalid-value.ts:10](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-value.ts#L10) +[lib/error/invalid-value.ts:10](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-value.ts#L10) ## Properties @@ -170,7 +170,7 @@ node_modules/@types/node/globals.d.ts:13 #### Defined in -[lib/error/invalid-value.ts:16](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-value.ts#L16) +[lib/error/invalid-value.ts:16](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-value.ts#L16) ___ @@ -184,7 +184,7 @@ ___ #### Defined in -[lib/error/invalid-value.ts:17](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-value.ts#L17) +[lib/error/invalid-value.ts:17](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-value.ts#L17) ___ @@ -198,7 +198,7 @@ ___ #### Defined in -[lib/error/invalid-value.ts:18](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/invalid-value.ts#L18) +[lib/error/invalid-value.ts:18](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-value.ts#L18) ## Methods diff --git a/docs/classes/PointOutOfRange.md b/docs/classes/PointOutOfRange.md index f50f6973..1c82185b 100644 --- a/docs/classes/PointOutOfRange.md +++ b/docs/classes/PointOutOfRange.md @@ -49,7 +49,7 @@ #### Defined in -[lib/error/point-out-of-range.ts:9](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/point-out-of-range.ts#L9) +[lib/error/point-out-of-range.ts:9](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/point-out-of-range.ts#L9) ## Properties @@ -173,7 +173,7 @@ node_modules/@types/node/globals.d.ts:13 #### Defined in -[lib/error/point-out-of-range.ts:15](https://github.com/redis/redis-om-node/blob/4f5798b/lib/error/point-out-of-range.ts#L15) +[lib/error/point-out-of-range.ts:15](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/point-out-of-range.ts#L15) ## Methods diff --git a/docs/classes/RawSearch.md b/docs/classes/RawSearch.md index 2758ca6d..7bf3cce5 100644 --- a/docs/classes/RawSearch.md +++ b/docs/classes/RawSearch.md @@ -82,7 +82,7 @@ AbstractSearch.return #### Defined in -[lib/search/search.ts:308](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L308) +[lib/search/search.ts:308](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L308) ## Methods @@ -118,7 +118,7 @@ An array of [Entities](../README.md#entity) matching the query. #### Defined in -[lib/search/search.ts:264](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L264) +[lib/search/search.ts:264](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L264) ___ @@ -154,7 +154,7 @@ An array of entity IDs matching the query. #### Defined in -[lib/search/search.ts:282](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L282) +[lib/search/search.ts:282](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L282) ___ @@ -190,7 +190,7 @@ An array of key names matching the query. #### Defined in -[lib/search/search.ts:300](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L300) +[lib/search/search.ts:300](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L300) ___ @@ -210,7 +210,7 @@ Returns the number of [Entities](../README.md#entity) that match this query. #### Defined in -[lib/search/search.ts:188](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L188) +[lib/search/search.ts:188](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L188) ___ @@ -230,7 +230,7 @@ Returns the first [Entity](../README.md#entity) that matches this query. #### Defined in -[lib/search/search.ts:229](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L229) +[lib/search/search.ts:229](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L229) ___ @@ -250,7 +250,7 @@ Returns the first entity ID that matches this query. #### Defined in -[lib/search/search.ts:237](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L237) +[lib/search/search.ts:237](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L237) ___ @@ -270,7 +270,7 @@ Returns the first key name that matches this query. #### Defined in -[lib/search/search.ts:245](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L245) +[lib/search/search.ts:245](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L245) ___ @@ -298,7 +298,7 @@ The entity ID [Entity](../README.md#entity) with the maximal value #### Defined in -[lib/search/search.ts:162](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L162) +[lib/search/search.ts:162](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L162) ___ @@ -326,7 +326,7 @@ The entity ID with the maximal value #### Defined in -[lib/search/search.ts:171](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L171) +[lib/search/search.ts:171](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L171) ___ @@ -354,7 +354,7 @@ The key name with the maximal value #### Defined in -[lib/search/search.ts:180](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L180) +[lib/search/search.ts:180](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L180) ___ @@ -382,7 +382,7 @@ The [Entity](../README.md#entity) with the minimal value #### Defined in -[lib/search/search.ts:135](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L135) +[lib/search/search.ts:135](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L135) ___ @@ -410,7 +410,7 @@ The entity ID with the minimal value #### Defined in -[lib/search/search.ts:144](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L144) +[lib/search/search.ts:144](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L144) ___ @@ -438,7 +438,7 @@ The key name with the minimal value #### Defined in -[lib/search/search.ts:153](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L153) +[lib/search/search.ts:153](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L153) ___ @@ -467,7 +467,7 @@ An array of [Entities](../README.md#entity) matching the query. #### Defined in -[lib/search/search.ts:199](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L199) +[lib/search/search.ts:199](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L199) ___ @@ -496,7 +496,7 @@ An array of strings matching the query. #### Defined in -[lib/search/search.ts:210](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L210) +[lib/search/search.ts:210](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L210) ___ @@ -525,7 +525,7 @@ An array of strings matching the query. #### Defined in -[lib/search/search.ts:221](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L221) +[lib/search/search.ts:221](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L221) ___ @@ -552,7 +552,7 @@ Alias for [all](Search.md#all). #### Defined in -[lib/search/search.ts:406](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L406) +[lib/search/search.ts:406](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L406) ___ @@ -579,7 +579,7 @@ Alias for [allIds](Search.md#allids). #### Defined in -[lib/search/search.ts:413](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L413) +[lib/search/search.ts:413](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L413) ___ @@ -606,7 +606,7 @@ Alias for [allKeys](Search.md#allkeys). #### Defined in -[lib/search/search.ts:420](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L420) +[lib/search/search.ts:420](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L420) ___ @@ -626,7 +626,7 @@ Alias for [count](Search.md#count). #### Defined in -[lib/search/search.ts:357](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L357) +[lib/search/search.ts:357](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L357) ___ @@ -646,7 +646,7 @@ Alias for [first](Search.md#first). #### Defined in -[lib/search/search.ts:385](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L385) +[lib/search/search.ts:385](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L385) ___ @@ -666,7 +666,7 @@ Alias for [firstId](Search.md#firstid). #### Defined in -[lib/search/search.ts:392](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L392) +[lib/search/search.ts:392](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L392) ___ @@ -686,7 +686,7 @@ Alias for [firstKey](Search.md#firstkey). #### Defined in -[lib/search/search.ts:399](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L399) +[lib/search/search.ts:399](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L399) ___ @@ -712,7 +712,7 @@ Alias for [max](Search.md#max). #### Defined in -[lib/search/search.ts:336](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L336) +[lib/search/search.ts:336](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L336) ___ @@ -738,7 +738,7 @@ Alias for [maxId](Search.md#maxid). #### Defined in -[lib/search/search.ts:343](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L343) +[lib/search/search.ts:343](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L343) ___ @@ -764,7 +764,7 @@ Alias for [maxKey](Search.md#maxkey). #### Defined in -[lib/search/search.ts:350](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L350) +[lib/search/search.ts:350](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L350) ___ @@ -790,7 +790,7 @@ Alias for [min](Search.md#min). #### Defined in -[lib/search/search.ts:315](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L315) +[lib/search/search.ts:315](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L315) ___ @@ -816,7 +816,7 @@ Alias for [minId](Search.md#minid). #### Defined in -[lib/search/search.ts:322](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L322) +[lib/search/search.ts:322](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L322) ___ @@ -842,7 +842,7 @@ Alias for [minKey](Search.md#minkey). #### Defined in -[lib/search/search.ts:329](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L329) +[lib/search/search.ts:329](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L329) ___ @@ -869,7 +869,7 @@ Alias for [page](Search.md#page). #### Defined in -[lib/search/search.ts:364](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L364) +[lib/search/search.ts:364](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L364) ___ @@ -896,7 +896,7 @@ Alias for [pageOfIds](Search.md#pageofids). #### Defined in -[lib/search/search.ts:371](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L371) +[lib/search/search.ts:371](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L371) ___ @@ -923,7 +923,7 @@ Alias for [pageOfKeys](Search.md#pageofkeys). #### Defined in -[lib/search/search.ts:378](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L378) +[lib/search/search.ts:378](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L378) ___ @@ -949,7 +949,7 @@ Alias for [sortAscending](Search.md#sortascending). #### Defined in -[lib/search/search.ts:86](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L86) +[lib/search/search.ts:86](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L86) ___ @@ -977,7 +977,7 @@ this #### Defined in -[lib/search/search.ts:63](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L63) +[lib/search/search.ts:63](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L63) ___ @@ -1006,7 +1006,7 @@ this #### Defined in -[lib/search/search.ts:96](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L96) +[lib/search/search.ts:96](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L96) ___ @@ -1032,7 +1032,7 @@ Alias for [sortDescending](Search.md#sortdescending). #### Defined in -[lib/search/search.ts:70](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L70) +[lib/search/search.ts:70](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L70) ___ @@ -1060,4 +1060,4 @@ this #### Defined in -[lib/search/search.ts:79](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L79) +[lib/search/search.ts:79](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L79) diff --git a/docs/classes/Repository.md b/docs/classes/Repository.md index f2ede131..86a92d1d 100644 --- a/docs/classes/Repository.md +++ b/docs/classes/Repository.md @@ -48,6 +48,7 @@ const entities = await repository.search() - [createIndex](Repository.md#createindex) - [dropIndex](Repository.md#dropindex) - [expire](Repository.md#expire) +- [expireAt](Repository.md#expireat) - [fetch](Repository.md#fetch) - [remove](Repository.md#remove) - [save](Repository.md#save) @@ -71,7 +72,7 @@ Creates a new [Repository](Repository.md). #### Defined in -[lib/repository/repository.ts:56](https://github.com/redis/redis-om-node/blob/4f5798b/lib/repository/repository.ts#L56) +[lib/repository/repository.ts:56](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L56) ## Methods @@ -89,7 +90,7 @@ RediSearch and RedisJSON are installed on your instance of Redis. #### Defined in -[lib/repository/repository.ts:71](https://github.com/redis/redis-om-node/blob/4f5798b/lib/repository/repository.ts#L71) +[lib/repository/repository.ts:71](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L71) ___ @@ -107,7 +108,7 @@ on your instance of Redis. #### Defined in -[lib/repository/repository.ts:109](https://github.com/redis/redis-om-node/blob/4f5798b/lib/repository/repository.ts#L109) +[lib/repository/repository.ts:109](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L109) ___ @@ -131,7 +132,7 @@ found, does nothing. #### Defined in -[lib/repository/repository.ts:242](https://github.com/redis/redis-om-node/blob/4f5798b/lib/repository/repository.ts#L242) +[lib/repository/repository.ts:242](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L242) ▸ **expire**(`ids`, `ttlInSeconds`): `Promise`<`void`\> @@ -151,7 +152,51 @@ ids. If a particular [Entity](../README.md#entity) is not found, does nothing. #### Defined in -[lib/repository/repository.ts:250](https://github.com/redis/redis-om-node/blob/4f5798b/lib/repository/repository.ts#L250) +[lib/repository/repository.ts:250](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L250) + +___ + +### expireAt + +▸ **expireAt**(`id`, `expirationDate`): `Promise`<`void`\> + +Use Date object to set the [Entity](../README.md#entity)'s time to live. If the [Entity](../README.md#entity) +is not found, does nothing. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | The ID of the [Entity](../README.md#entity) to set an expiration date for. | +| `expirationDate` | `Date` | The time the data should expire. | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[lib/repository/repository.ts:269](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L269) + +▸ **expireAt**(`ids`, `expirationDate`): `Promise`<`void`\> + +Use Date object to set the [Entities](../README.md#entity) in Redis with the given +ids. If a particular [Entity](../README.md#entity) is not found, does nothing. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `ids` | `string`[] | The IDs of the [Entities](../README.md#entity) to set an expiration date for. | +| `expirationDate` | `Date` | The time the data should expire. | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[lib/repository/repository.ts:278](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L278) ___ @@ -176,7 +221,7 @@ The matching Entity. #### Defined in -[lib/repository/repository.ts:171](https://github.com/redis/redis-om-node/blob/4f5798b/lib/repository/repository.ts#L171) +[lib/repository/repository.ts:171](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L171) ▸ **fetch**(`...ids`): `Promise`<[`Entity`](../README.md#entity)[]\> @@ -197,7 +242,7 @@ The matching Entities. #### Defined in -[lib/repository/repository.ts:180](https://github.com/redis/redis-om-node/blob/4f5798b/lib/repository/repository.ts#L180) +[lib/repository/repository.ts:180](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L180) ▸ **fetch**(`ids`): `Promise`<[`Entity`](../README.md#entity)[]\> @@ -218,7 +263,7 @@ The matching Entities. #### Defined in -[lib/repository/repository.ts:189](https://github.com/redis/redis-om-node/blob/4f5798b/lib/repository/repository.ts#L189) +[lib/repository/repository.ts:189](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L189) ___ @@ -241,7 +286,7 @@ not found, does nothing. #### Defined in -[lib/repository/repository.ts:205](https://github.com/redis/redis-om-node/blob/4f5798b/lib/repository/repository.ts#L205) +[lib/repository/repository.ts:205](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L205) ▸ **remove**(`...ids`): `Promise`<`void`\> @@ -260,7 +305,7 @@ particular [Entity](../README.md#entity) is not found, does nothing. #### Defined in -[lib/repository/repository.ts:213](https://github.com/redis/redis-om-node/blob/4f5798b/lib/repository/repository.ts#L213) +[lib/repository/repository.ts:213](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L213) ▸ **remove**(`ids`): `Promise`<`void`\> @@ -279,7 +324,7 @@ particular [Entity](../README.md#entity) is not found, does nothing. #### Defined in -[lib/repository/repository.ts:221](https://github.com/redis/redis-om-node/blob/4f5798b/lib/repository/repository.ts#L221) +[lib/repository/repository.ts:221](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L221) ___ @@ -304,7 +349,7 @@ A copy of the provided Entity with EntityId and EntityKeyName properties added. #### Defined in -[lib/repository/repository.ts:134](https://github.com/redis/redis-om-node/blob/4f5798b/lib/repository/repository.ts#L134) +[lib/repository/repository.ts:134](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L134) ▸ **save**(`id`, `entity`): `Promise`<[`Entity`](../README.md#entity)\> @@ -325,7 +370,7 @@ A copy of the provided Entity with EntityId and EntityKeyName properties added. #### Defined in -[lib/repository/repository.ts:143](https://github.com/redis/redis-om-node/blob/4f5798b/lib/repository/repository.ts#L143) +[lib/repository/repository.ts:143](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L143) ___ @@ -344,7 +389,7 @@ A [Search](Search.md) object. #### Defined in -[lib/repository/repository.ts:268](https://github.com/redis/redis-om-node/blob/4f5798b/lib/repository/repository.ts#L268) +[lib/repository/repository.ts:301](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L301) ___ @@ -377,4 +422,4 @@ A [RawSearch](RawSearch.md) object. #### Defined in -[lib/repository/repository.ts:283](https://github.com/redis/redis-om-node/blob/4f5798b/lib/repository/repository.ts#L283) +[lib/repository/repository.ts:316](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L316) diff --git a/docs/classes/Schema.md b/docs/classes/Schema.md index 91646fdc..d2dff0cb 100644 --- a/docs/classes/Schema.md +++ b/docs/classes/Schema.md @@ -63,7 +63,7 @@ Constructs a Schema. #### Defined in -[lib/schema/schema.ts:49](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/schema.ts#L49) +[lib/schema/schema.ts:49](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/schema.ts#L49) ## Accessors @@ -80,7 +80,7 @@ that this Schema uses to store [Entities](../README.md#entity) in Redis. #### Defined in -[lib/schema/schema.ts:92](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/schema.ts#L92) +[lib/schema/schema.ts:92](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/schema.ts#L92) ___ @@ -96,7 +96,7 @@ The [Fields](Field.md) defined by this Schema. #### Defined in -[lib/schema/schema.ts:68](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/schema.ts#L68) +[lib/schema/schema.ts:68](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/schema.ts#L68) ___ @@ -113,7 +113,7 @@ changed when calling [createIndex](Repository.md#createindex). #### Defined in -[lib/schema/schema.ts:120](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/schema.ts#L120) +[lib/schema/schema.ts:120](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/schema.ts#L120) ___ @@ -129,7 +129,7 @@ The configured name for the RediSearch index hash for this Schema. #### Defined in -[lib/schema/schema.ts:86](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/schema.ts#L86) +[lib/schema/schema.ts:86](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/schema.ts#L86) ___ @@ -145,7 +145,7 @@ The configured name for the RediSearch index for this Schema. #### Defined in -[lib/schema/schema.ts:83](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/schema.ts#L83) +[lib/schema/schema.ts:83](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/schema.ts#L83) ___ @@ -163,7 +163,7 @@ idStrategy returns `12345` then the generated key would be `foo:12345`. #### Defined in -[lib/schema/schema.ts:63](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/schema.ts#L63) +[lib/schema/schema.ts:63](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/schema.ts#L63) ___ @@ -180,7 +180,7 @@ than `CUSTOM`. #### Defined in -[lib/schema/schema.ts:104](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/schema.ts#L104) +[lib/schema/schema.ts:104](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/schema.ts#L104) ___ @@ -197,7 +197,7 @@ or `CUSTOM`. See [SchemaOptions](../README.md#schemaoptions) for more details. #### Defined in -[lib/schema/schema.ts:98](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/schema.ts#L98) +[lib/schema/schema.ts:98](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/schema.ts#L98) ## Methods @@ -221,7 +221,7 @@ The [Field](Field.md), or null of not found. #### Defined in -[lib/schema/schema.ts:78](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/schema.ts#L78) +[lib/schema/schema.ts:78](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/schema.ts#L78) ___ @@ -239,4 +239,4 @@ The generated id. #### Defined in -[lib/schema/schema.ts:111](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/schema.ts#L111) +[lib/schema/schema.ts:111](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/schema.ts#L111) diff --git a/docs/classes/Search.md b/docs/classes/Search.md index da087dfa..e9921871 100644 --- a/docs/classes/Search.md +++ b/docs/classes/Search.md @@ -84,7 +84,7 @@ AbstractSearch.return #### Defined in -[lib/search/search.ts:308](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L308) +[lib/search/search.ts:308](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L308) ## Methods @@ -120,7 +120,7 @@ An array of [Entities](../README.md#entity) matching the query. #### Defined in -[lib/search/search.ts:264](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L264) +[lib/search/search.ts:264](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L264) ___ @@ -156,7 +156,7 @@ An array of entity IDs matching the query. #### Defined in -[lib/search/search.ts:282](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L282) +[lib/search/search.ts:282](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L282) ___ @@ -192,7 +192,7 @@ An array of key names matching the query. #### Defined in -[lib/search/search.ts:300](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L300) +[lib/search/search.ts:300](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L300) ___ @@ -216,7 +216,7 @@ A subclass of [WhereField](WhereField.md) matching the type of the field. #### Defined in -[lib/search/search.ts:530](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L530) +[lib/search/search.ts:530](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L530) ▸ **and**(`subSearchFn`): [`Search`](Search.md) @@ -236,7 +236,7 @@ Sets up a nested search as a logical AND. #### Defined in -[lib/search/search.ts:537](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L537) +[lib/search/search.ts:537](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L537) ___ @@ -256,7 +256,7 @@ Returns the number of [Entities](../README.md#entity) that match this query. #### Defined in -[lib/search/search.ts:188](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L188) +[lib/search/search.ts:188](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L188) ___ @@ -276,7 +276,7 @@ Returns the first [Entity](../README.md#entity) that matches this query. #### Defined in -[lib/search/search.ts:229](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L229) +[lib/search/search.ts:229](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L229) ___ @@ -296,7 +296,7 @@ Returns the first entity ID that matches this query. #### Defined in -[lib/search/search.ts:237](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L237) +[lib/search/search.ts:237](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L237) ___ @@ -316,7 +316,7 @@ Returns the first key name that matches this query. #### Defined in -[lib/search/search.ts:245](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L245) +[lib/search/search.ts:245](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L245) ___ @@ -344,7 +344,7 @@ The entity ID [Entity](../README.md#entity) with the maximal value #### Defined in -[lib/search/search.ts:162](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L162) +[lib/search/search.ts:162](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L162) ___ @@ -372,7 +372,7 @@ The entity ID with the maximal value #### Defined in -[lib/search/search.ts:171](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L171) +[lib/search/search.ts:171](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L171) ___ @@ -400,7 +400,7 @@ The key name with the maximal value #### Defined in -[lib/search/search.ts:180](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L180) +[lib/search/search.ts:180](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L180) ___ @@ -428,7 +428,7 @@ The [Entity](../README.md#entity) with the minimal value #### Defined in -[lib/search/search.ts:135](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L135) +[lib/search/search.ts:135](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L135) ___ @@ -456,7 +456,7 @@ The entity ID with the minimal value #### Defined in -[lib/search/search.ts:144](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L144) +[lib/search/search.ts:144](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L144) ___ @@ -484,7 +484,7 @@ The key name with the minimal value #### Defined in -[lib/search/search.ts:153](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L153) +[lib/search/search.ts:153](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L153) ___ @@ -508,7 +508,7 @@ A subclass of [WhereField](WhereField.md) matching the type of the field. #### Defined in -[lib/search/search.ts:547](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L547) +[lib/search/search.ts:547](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L547) ▸ **or**(`subSearchFn`): [`Search`](Search.md) @@ -528,7 +528,7 @@ Sets up a nested search as a logical OR. #### Defined in -[lib/search/search.ts:554](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L554) +[lib/search/search.ts:554](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L554) ___ @@ -557,7 +557,7 @@ An array of [Entities](../README.md#entity) matching the query. #### Defined in -[lib/search/search.ts:199](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L199) +[lib/search/search.ts:199](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L199) ___ @@ -586,7 +586,7 @@ An array of strings matching the query. #### Defined in -[lib/search/search.ts:210](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L210) +[lib/search/search.ts:210](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L210) ___ @@ -615,7 +615,7 @@ An array of strings matching the query. #### Defined in -[lib/search/search.ts:221](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L221) +[lib/search/search.ts:221](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L221) ___ @@ -642,7 +642,7 @@ Alias for [all](Search.md#all). #### Defined in -[lib/search/search.ts:406](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L406) +[lib/search/search.ts:406](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L406) ___ @@ -669,7 +669,7 @@ Alias for [allIds](Search.md#allids). #### Defined in -[lib/search/search.ts:413](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L413) +[lib/search/search.ts:413](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L413) ___ @@ -696,7 +696,7 @@ Alias for [allKeys](Search.md#allkeys). #### Defined in -[lib/search/search.ts:420](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L420) +[lib/search/search.ts:420](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L420) ___ @@ -716,7 +716,7 @@ Alias for [count](Search.md#count). #### Defined in -[lib/search/search.ts:357](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L357) +[lib/search/search.ts:357](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L357) ___ @@ -736,7 +736,7 @@ Alias for [first](Search.md#first). #### Defined in -[lib/search/search.ts:385](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L385) +[lib/search/search.ts:385](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L385) ___ @@ -756,7 +756,7 @@ Alias for [firstId](Search.md#firstid). #### Defined in -[lib/search/search.ts:392](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L392) +[lib/search/search.ts:392](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L392) ___ @@ -776,7 +776,7 @@ Alias for [firstKey](Search.md#firstkey). #### Defined in -[lib/search/search.ts:399](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L399) +[lib/search/search.ts:399](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L399) ___ @@ -802,7 +802,7 @@ Alias for [max](Search.md#max). #### Defined in -[lib/search/search.ts:336](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L336) +[lib/search/search.ts:336](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L336) ___ @@ -828,7 +828,7 @@ Alias for [maxId](Search.md#maxid). #### Defined in -[lib/search/search.ts:343](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L343) +[lib/search/search.ts:343](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L343) ___ @@ -854,7 +854,7 @@ Alias for [maxKey](Search.md#maxkey). #### Defined in -[lib/search/search.ts:350](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L350) +[lib/search/search.ts:350](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L350) ___ @@ -880,7 +880,7 @@ Alias for [min](Search.md#min). #### Defined in -[lib/search/search.ts:315](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L315) +[lib/search/search.ts:315](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L315) ___ @@ -906,7 +906,7 @@ Alias for [minId](Search.md#minid). #### Defined in -[lib/search/search.ts:322](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L322) +[lib/search/search.ts:322](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L322) ___ @@ -932,7 +932,7 @@ Alias for [minKey](Search.md#minkey). #### Defined in -[lib/search/search.ts:329](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L329) +[lib/search/search.ts:329](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L329) ___ @@ -959,7 +959,7 @@ Alias for [page](Search.md#page). #### Defined in -[lib/search/search.ts:364](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L364) +[lib/search/search.ts:364](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L364) ___ @@ -986,7 +986,7 @@ Alias for [pageOfIds](Search.md#pageofids). #### Defined in -[lib/search/search.ts:371](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L371) +[lib/search/search.ts:371](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L371) ___ @@ -1013,7 +1013,7 @@ Alias for [pageOfKeys](Search.md#pageofkeys). #### Defined in -[lib/search/search.ts:378](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L378) +[lib/search/search.ts:378](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L378) ___ @@ -1039,7 +1039,7 @@ Alias for [sortAscending](Search.md#sortascending). #### Defined in -[lib/search/search.ts:86](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L86) +[lib/search/search.ts:86](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L86) ___ @@ -1067,7 +1067,7 @@ this #### Defined in -[lib/search/search.ts:63](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L63) +[lib/search/search.ts:63](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L63) ___ @@ -1096,7 +1096,7 @@ this #### Defined in -[lib/search/search.ts:96](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L96) +[lib/search/search.ts:96](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L96) ___ @@ -1122,7 +1122,7 @@ Alias for [sortDescending](Search.md#sortdescending). #### Defined in -[lib/search/search.ts:70](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L70) +[lib/search/search.ts:70](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L70) ___ @@ -1150,7 +1150,7 @@ this #### Defined in -[lib/search/search.ts:79](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L79) +[lib/search/search.ts:79](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L79) ___ @@ -1175,7 +1175,7 @@ A subclass of [WhereField](WhereField.md) matching the type of the field. #### Defined in -[lib/search/search.ts:512](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L512) +[lib/search/search.ts:512](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L512) ▸ **where**(`subSearchFn`): [`Search`](Search.md) @@ -1196,4 +1196,4 @@ they are treated logically as AND. #### Defined in -[lib/search/search.ts:520](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L520) +[lib/search/search.ts:520](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/search.ts#L520) diff --git a/docs/classes/Where.md b/docs/classes/Where.md index e9bcd95b..8cd06b00 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/4f5798b/lib/search/where.ts#L8) +[lib/search/where.ts:8](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where.ts#L8) diff --git a/docs/classes/WhereField.md b/docs/classes/WhereField.md index 1103bd95..d2d39e3d 100644 --- a/docs/classes/WhereField.md +++ b/docs/classes/WhereField.md @@ -71,7 +71,7 @@ this multiple times will have no effect. #### Defined in -[lib/search/where-field.ts:92](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-field.ts#L92) +[lib/search/where-field.ts:96](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L96) ___ @@ -84,7 +84,7 @@ this multiple times will have no effect. #### Defined in -[lib/search/where-field.ts:99](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-field.ts#L99) +[lib/search/where-field.ts:103](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L103) ## Accessors @@ -102,7 +102,7 @@ this #### Defined in -[lib/search/where-field.ts:289](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-field.ts#L289) +[lib/search/where-field.ts:293](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L293) ___ @@ -120,7 +120,7 @@ this #### Defined in -[lib/search/where-field.ts:281](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-field.ts#L281) +[lib/search/where-field.ts:285](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L285) ___ @@ -139,7 +139,7 @@ this #### Defined in -[lib/search/where-field.ts:298](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-field.ts#L298) +[lib/search/where-field.ts:302](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L302) ## Methods @@ -163,7 +163,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:240](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-field.ts#L240) +[lib/search/where-field.ts:244](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L244) ___ @@ -187,7 +187,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:233](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-field.ts#L233) +[lib/search/where-field.ts:237](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L237) ___ @@ -212,7 +212,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:175](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-field.ts#L175) +[lib/search/where-field.ts:179](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L179) ___ @@ -236,7 +236,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:182](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-field.ts#L182) +[lib/search/where-field.ts:186](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L186) ___ @@ -261,7 +261,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:197](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-field.ts#L197) +[lib/search/where-field.ts:201](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L201) ___ @@ -285,7 +285,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:189](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-field.ts#L189) +[lib/search/where-field.ts:193](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L193) ___ @@ -310,7 +310,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:205](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-field.ts#L205) +[lib/search/where-field.ts:209](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L209) ___ @@ -337,7 +337,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:20](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-field.ts#L20) +[lib/search/where-field.ts:20](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L20) ___ @@ -364,7 +364,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:30](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-field.ts#L30) +[lib/search/where-field.ts:30](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L30) ___ @@ -391,7 +391,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:50](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-field.ts#L50) +[lib/search/where-field.ts:50](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L50) ___ @@ -418,7 +418,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:40](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-field.ts#L40) +[lib/search/where-field.ts:40](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L40) ___ @@ -436,7 +436,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:111](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-field.ts#L111) +[lib/search/where-field.ts:115](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L115) ___ @@ -460,7 +460,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:125](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-field.ts#L125) +[lib/search/where-field.ts:129](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L129) ___ @@ -484,7 +484,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:139](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-field.ts#L139) +[lib/search/where-field.ts:143](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L143) ___ @@ -508,7 +508,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:118](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-field.ts#L118) +[lib/search/where-field.ts:122](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L122) ___ @@ -532,7 +532,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:132](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-field.ts#L132) +[lib/search/where-field.ts:136](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L136) ___ @@ -556,7 +556,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:212](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-field.ts#L212) +[lib/search/where-field.ts:216](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L216) ___ @@ -580,7 +580,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:219](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-field.ts#L219) +[lib/search/where-field.ts:223](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L223) ___ @@ -604,7 +604,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:153](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-field.ts#L153) +[lib/search/where-field.ts:157](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L157) ___ @@ -628,7 +628,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:167](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-field.ts#L167) +[lib/search/where-field.ts:171](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L171) ___ @@ -652,7 +652,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:146](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-field.ts#L146) +[lib/search/where-field.ts:150](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L150) ___ @@ -676,13 +676,13 @@ 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/4f5798b/lib/search/where-field.ts#L160) +[lib/search/where-field.ts:164](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L164) ___ ### match -▸ **match**(`value`): [`Search`](Search.md) +▸ **match**(`value`, `options?`): [`Search`](Search.md) Adds a full-text search comparison to the query. @@ -691,6 +691,9 @@ Adds a full-text search comparison to the query. | Name | Type | Description | | :------ | :------ | :------ | | `value` | `string` \| `number` \| `boolean` | The word or phrase sought. | +| `options?` | `Object` | - | +| `options.fuzzyMatching?` | `boolean` | Whether to use fuzzy matching to find the sought word or phrase. Defaults to `false`. | +| `options.levenshteinDistance?` | ``2`` \| ``1`` \| ``3`` | The levenshtein distance to use for fuzzy matching. Supported values are `1`, `2`, and `3`. Defaults to `1`. | #### Returns @@ -700,7 +703,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/4f5798b/lib/search/where-field.ts#L57) +[lib/search/where-field.ts:59](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L59) ___ @@ -724,7 +727,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/4f5798b/lib/search/where-field.ts#L71) +[lib/search/where-field.ts:75](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L75) ___ @@ -748,13 +751,13 @@ 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/4f5798b/lib/search/where-field.ts#L78) +[lib/search/where-field.ts:82](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L82) ___ ### matches -▸ **matches**(`value`): [`Search`](Search.md) +▸ **matches**(`value`, `options?`): [`Search`](Search.md) Adds a full-text search comparison to the query. @@ -763,6 +766,9 @@ Adds a full-text search comparison to the query. | Name | Type | Description | | :------ | :------ | :------ | | `value` | `string` \| `number` \| `boolean` | The word or phrase sought. | +| `options?` | `Object` | - | +| `options.fuzzyMatching?` | `boolean` | Whether to use fuzzy matching to find the sought word or phrase. Defaults to `false`. | +| `options.levenshteinDistance?` | ``2`` \| ``1`` \| ``3`` | The levenshtein distance to use for fuzzy matching. Supported values are `1`, `2`, and `3`. Defaults to `1`. | #### Returns @@ -772,7 +778,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/4f5798b/lib/search/where-field.ts#L64) +[lib/search/where-field.ts:68](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L68) ___ @@ -796,7 +802,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/4f5798b/lib/search/where-field.ts#L85) +[lib/search/where-field.ts:89](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L89) ___ @@ -820,7 +826,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/4f5798b/lib/search/where-field.ts#L226) +[lib/search/where-field.ts:230](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L230) ___ @@ -844,7 +850,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/4f5798b/lib/search/where-field.ts#L254) +[lib/search/where-field.ts:258](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L258) ___ @@ -868,7 +874,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/4f5798b/lib/search/where-field.ts#L247) +[lib/search/where-field.ts:251](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L251) ___ @@ -888,7 +894,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/4f5798b/lib/search/where-field.ts#L303) +[lib/search/where-field.ts:307](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L307) ___ @@ -906,4 +912,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/4f5798b/lib/search/where-field.ts#L105) +[lib/search/where-field.ts:109](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-field.ts#L109) diff --git a/package-lock.json b/package-lock.json index 8a0b7f18..4194c6b7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "redis-om", - "version": "0.4.2", + "version": "0.4.3", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "redis-om", - "version": "0.4.2", + "version": "0.4.3", "license": "MIT", "dependencies": { "jsonpath-plus": "^7.2.0", diff --git a/package.json b/package.json index 10217879..29d78733 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "redis-om", - "version": "0.4.2", + "version": "0.4.3", "description": "Object mapping, and more, for Redis and Node.js. Written in TypeScript.", "main": "dist/index.js", "types": "./dist/index.d.ts", diff --git a/spec/functional/search/search-hash.spec.ts b/spec/functional/search/search-hash.spec.ts index f0ea3ddb..67a57215 100644 --- a/spec/functional/search/search-hash.spec.ts +++ b/spec/functional/search/search-hash.spec.ts @@ -31,7 +31,7 @@ describe("search for hashes", () => { repository = new Repository(schema, redis) await repository.createIndex() - await sleep(50) // Yuck! Gotta wait for RediSearch to index everything. + await sleep(1000) // Yuck! Gotta wait for RediSearch to index everything. }) afterAll(async () => { diff --git a/spec/functional/search/search-json.spec.ts b/spec/functional/search/search-json.spec.ts index 28f5496c..ec2928ec 100644 --- a/spec/functional/search/search-json.spec.ts +++ b/spec/functional/search/search-json.spec.ts @@ -31,7 +31,7 @@ describe("search for JSON documents", () => { repository = new Repository(schema, redis) await repository.createIndex() - await sleep(50) // Yuck! Gotta wait for RediSearch to index everything. + await sleep(1000) // Yuck! Gotta wait for RediSearch to index everything. }) afterAll(async () => {