diff --git a/.nvmrc b/.nvmrc index dae199ae..05e40f23 100644 --- a/.nvmrc +++ b/.nvmrc @@ -1 +1 @@ -v12 +v14.8 diff --git a/CHANGELOG b/CHANGELOG index 319e6f35..750f255f 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -4,6 +4,19 @@ 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.3.0 - 2022-04-28 +### Changed +- Internal changes in preparation for adding embeddable objects. +- Performance improvements. +- Renamed and reorganized some types that might affect TypeScript users. +- Removed support for Node 12. +- Changed examples in README to assume top-level awaits are available. + +### Fixed +- Fixed error in sample code when calling `.use`. + + ## 0.2.1 - 2022-03-30 ### Added - Added limited ability to sort search results using `.sortBy`. diff --git a/README.md b/README.md index a1b50809..816f35d1 100644 --- a/README.md +++ b/README.md @@ -142,23 +142,19 @@ You connect to Redis using a [*client*](docs/classes/Client.md). The `Client` cl ```javascript import { Client } from 'redis-om' -(async function() { +const client = new Client() +await client.open('redis://localhost:6379') - const client = new Client() - await client.open('redis://localhost:6379') +const aString = await client.execute(['PING']) +// 'PONG' - const aString = await client.execute(['PING']) - // 'PONG' +const aNumber = await client.execute(['HSET', 'foo', 'bar', 'baz', 'qux', 42]) +// 2 - const aNumber = await client.execute(['HSET', 'foo', 'bar', 'baz', 'qux', 42]) - // 2 +const anArray = await client.execute(['HGETALL', 'foo']) +// [ 'bar', 'baz', 'qux', '42' ] - const anArray = await client.execute(['HGETALL', 'foo']) - // [ 'bar', 'baz', 'qux', '42' ] - - await client.close() - -})() +await client.close() ```
@@ -169,19 +165,18 @@ Typecasts can be done in 2 ways, casting it before the returning value `client.e ```typescript import { Client } from 'redis-om'; -(async () => { - let client = await new Client().open('redis://localhost:6379'); - let aString = await client.execute(['PING']); - // 'PONG' +let client = await new Client().open('redis://localhost:6379'); + +let aString = await client.execute(['PING']); +// 'PONG' - let aNumber = await client.execute(['HSET', 'foo', 'bar', 'baz', 'qux', 42]); - // 2 +let aNumber = await client.execute(['HSET', 'foo', 'bar', 'baz', 'qux', 42]); +// 2 - let anArray = await >client.execute(['HGETALL', 'foo']); - // [ 'bar', 'baz', 'qux', '42' ] - await client.close(); -})(); +let anArray = await >client.execute(['HGETALL', 'foo']); +// [ 'bar', 'baz', 'qux', '42' ] +await client.close(); ```
@@ -193,14 +188,12 @@ If you find you need to talk to Redis directly a *lot* or you need more than jus import { createClient } from 'redis' import { Client } from 'redis-om' -(async function() { +const redis = createClient('redis://localhost:6379') +await redis.connect() +const client = await new Client().use(redis) - const redis = createClient('redis://localhost:6379') - const client = await new Client().use(redis) - - await redis.set('foo', 'bar') - const value = await client.execute(['GET', 'foo']) -})() +await redis.set('foo', 'bar') +const value = await client.execute(['GET', 'foo']) ``` Use `.use` to take advantage of things like [clustering](https://github.com/redis/node-redis#clustering). Details on all that stuff are way beyond the scope of this README. You can read about it in the Node Redis [documentation](https://github.com/redis/node-redis). @@ -736,7 +729,7 @@ studios = await studioRepository.search().where('established').not.gt(date).retu studios = await studioRepository.search().where('established').greaterThan(date).return.all() studios = await studioRepository.search().where('established').is.greaterThan(date).return.all() studios = await studioRepository.search().where('established').is.not.greaterThan(date).return.all() - + studios = await studioRepository.search().where('established').gte(date).return.all() studios = await studioRepository.search().where('established').not.gte(date).return.all() studios = await studioRepository.search().where('established').greaterThanOrEqualTo(date).return.all() @@ -748,7 +741,7 @@ studios = await studioRepository.search().where('established').not.lt(date).retu studios = await studioRepository.search().where('established').lessThan(date).return.all() studios = await studioRepository.search().where('established').is.lessThan(date).return.all() studios = await studioRepository.search().where('established').is.not.lessThan(date).return.all() - + studios = await studioRepository.search().where('established').lte(date).return.all() studios = await studioRepository.search().where('established').not.lte(date).return.all() studios = await studioRepository.search().where('established').lessThanOrEqualTo(date).return.all() diff --git a/docs/README.md b/docs/README.md index 3ca347e8..84209314 100644 --- a/docs/README.md +++ b/docs/README.md @@ -20,28 +20,29 @@ redis-om ### Interfaces -- [BooleanField](interfaces/BooleanField.md) -- [DateField](interfaces/DateField.md) -- [Field](interfaces/Field.md) -- [NumberField](interfaces/NumberField.md) -- [PointField](interfaces/PointField.md) -- [Separable](interfaces/Separable.md) -- [Sortable](interfaces/Sortable.md) -- [StringArrayField](interfaces/StringArrayField.md) -- [StringField](interfaces/StringField.md) -- [TextField](interfaces/TextField.md) +- [BaseFieldDefinition](interfaces/BaseFieldDefinition.md) +- [BooleanFieldDefinition](interfaces/BooleanFieldDefinition.md) +- [DateFieldDefinition](interfaces/DateFieldDefinition.md) +- [NumberFieldDefinition](interfaces/NumberFieldDefinition.md) +- [PointFieldDefinition](interfaces/PointFieldDefinition.md) +- [SeparableFieldDefinition](interfaces/SeparableFieldDefinition.md) +- [SortableFieldDefinition](interfaces/SortableFieldDefinition.md) +- [StringArrayFieldDefinition](interfaces/StringArrayFieldDefinition.md) +- [StringFieldDefinition](interfaces/StringFieldDefinition.md) +- [TextFieldDefinition](interfaces/TextFieldDefinition.md) ### Type aliases - [CircleFunction](README.md#circlefunction) +- [DataStructure](README.md#datastructure) - [EntityConstructor](README.md#entityconstructor) -- [EntityCreationData](README.md#entitycreationdata) - [EntityData](README.md#entitydata) - [EntityValue](README.md#entityvalue) - [FieldDefinition](README.md#fielddefinition) - [IdStrategy](README.md#idstrategy) - [Point](README.md#point) - [SchemaDefinition](README.md#schemadefinition) +- [SchemaFieldType](README.md#schemafieldtype) - [SchemaOptions](README.md#schemaoptions) - [SearchDataStructure](README.md#searchdatastructure) - [StopWordOptions](README.md#stopwordoptions) @@ -71,7 +72,19 @@ A function that defines a circle for `.inCircle` searches. #### Defined in -[lib/search/where-point.ts:9](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-point.ts#L9) +[lib/search/where-point.ts:9](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-point.ts#L9) + +___ + +### DataStructure + +Ƭ **DataStructure**: ``"HASH"`` \| ``"JSON"`` + +The type of data structure in Redis to map objects to. + +#### Defined in + +[lib/schema/options/data-structure.ts:2](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/options/data-structure.ts#L2) ___ @@ -101,20 +114,7 @@ A constructor that creates an [Entity](classes/Entity.md) of type TEntity. #### Defined in -[lib/entity/entity.ts:18](https://github.com/redis/redis-om-node/blob/0843d26/lib/entity/entity.ts#L18) - -___ - -### EntityCreationData - -Ƭ **EntityCreationData**: `Record`<`string`, `number` \| `boolean` \| `string` \| `string`[] \| [`Point`](README.md#point) \| `Date` \| ``null``\> - -Initialization data for [Entity](classes/Entity.md) creation when calling -[Repository.createEntity](classes/Repository.md#createentity) or [Repository.createAndSave](classes/Repository.md#createandsave). - -#### Defined in - -[lib/repository/repository.ts:15](https://github.com/redis/redis-om-node/blob/0843d26/lib/repository/repository.ts#L15) +[lib/entity/entity-constructor.ts:8](https://github.com/redis/redis-om-node/blob/9708a58/lib/entity/entity-constructor.ts#L8) ___ @@ -126,31 +126,31 @@ A JavaScript object containing the underlying data of an [Entity](classes/Entity #### Defined in -[lib/entity/entity.ts:12](https://github.com/redis/redis-om-node/blob/0843d26/lib/entity/entity.ts#L12) +[lib/entity/entity-data.ts:6](https://github.com/redis/redis-om-node/blob/9708a58/lib/entity/entity-data.ts#L6) ___ ### EntityValue -Ƭ **EntityValue**: `number` \| `boolean` \| `string` \| [`Point`](README.md#point) \| `Date` \| `string`[] +Ƭ **EntityValue**: `string` \| `number` \| `boolean` \| [`Point`](README.md#point) \| `Date` \| `any`[] \| ``null`` -Valid values for properties of an [Entity](classes/Entity.md). +Valid types for properties on an [Entity](classes/Entity.md). #### Defined in -[lib/entity/entity.ts:7](https://github.com/redis/redis-om-node/blob/0843d26/lib/entity/entity.ts#L7) +[lib/entity/entity-value.ts:6](https://github.com/redis/redis-om-node/blob/9708a58/lib/entity/entity-value.ts#L6) ___ ### FieldDefinition -Ƭ **FieldDefinition**: [`StringField`](interfaces/StringField.md) \| [`TextField`](interfaces/TextField.md) \| [`NumberField`](interfaces/NumberField.md) \| [`BooleanField`](interfaces/BooleanField.md) \| [`PointField`](interfaces/PointField.md) \| [`DateField`](interfaces/DateField.md) \| [`StringArrayField`](interfaces/StringArrayField.md) +Ƭ **FieldDefinition**: [`StringFieldDefinition`](interfaces/StringFieldDefinition.md) \| [`TextFieldDefinition`](interfaces/TextFieldDefinition.md) \| [`NumberFieldDefinition`](interfaces/NumberFieldDefinition.md) \| [`BooleanFieldDefinition`](interfaces/BooleanFieldDefinition.md) \| [`PointFieldDefinition`](interfaces/PointFieldDefinition.md) \| [`DateFieldDefinition`](interfaces/DateFieldDefinition.md) \| [`StringArrayFieldDefinition`](interfaces/StringArrayFieldDefinition.md) Contains instructions telling how to map a property on an [Entity](classes/Entity.md) to Redis. #### Defined in -[lib/schema/definition/schema-definitions.ts:81](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L81) +[lib/schema/definition/field-definition.ts:10](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/field-definition.ts#L10) ___ @@ -170,7 +170,7 @@ A function that generates random [Entity IDs](classes/Entity.md#entityid). #### Defined in -[lib/schema/definition/schema-definitions.ts:89](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L89) +[lib/schema/options/id-strategy.ts:2](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/options/id-strategy.ts#L2) ___ @@ -189,7 +189,7 @@ Defines a point on the globe using longitude and latitude. #### Defined in -[lib/schema/definition/schema-definitions.ts:2](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L2) +[lib/entity/point.ts:2](https://github.com/redis/redis-om-node/blob/9708a58/lib/entity/point.ts#L2) ___ @@ -201,7 +201,19 @@ Group of [FieldDefinition](README.md#fielddefinition)s that define the schema fo #### Defined in -[lib/schema/definition/schema-definitions.ts:86](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L86) +[lib/schema/definition/schema-definition.ts:6](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/schema-definition.ts#L6) + +___ + +### SchemaFieldType + +Ƭ **SchemaFieldType**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"text"`` \| ``"date"`` \| ``"point"`` \| ``"array"`` + +Valid types a [FieldDefinition](README.md#fielddefinition). + +#### Defined in + +[lib/schema/definition/schema-field-type.ts:4](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/schema-field-type.ts#L4) ___ @@ -215,7 +227,7 @@ Configuration options for a [Schema](classes/Schema.md). | Name | Type | Description | | :------ | :------ | :------ | -| `dataStructure?` | [`SearchDataStructure`](README.md#searchdatastructure) | The data structure used to store the [Entity](classes/Entity.md) in Redis. Can be set to either `JSON` or `HASH`. Defaults to JSON. | +| `dataStructure?` | [`DataStructure`](README.md#datastructure) | The data structure used to store the [Entity](classes/Entity.md) in Redis. Can be set to either `JSON` or `HASH`. Defaults to JSON. | | `idStrategy?` | [`IdStrategy`](README.md#idstrategy) | A function that generates a random [Entity ID](classes/Entity.md#entityid). Defaults to a function that generates [ULIDs](https://github.com/ulid/spec). Combined with prefix to generate a Redis key. If prefix is `Foo` and idStratgey returns `12345` then the generated key would be `Foo:12345`. | | `indexHashName?` | `string` | The name used by Redis OM to store the hash of the index for this [Schema](classes/Schema.md). Defaults to prefix followed by `:index:hash`. So, for a prefix of `Foo`, it would use `Foo:index:hash`. | | `indexName?` | `string` | The name used by RediSearch to store the index for this [Schema](classes/Schema.md). Defaults to prefix followed by `:index`. So, for a prefix of `Foo`, it would use `Foo:index`. | @@ -225,7 +237,7 @@ Configuration options for a [Schema](classes/Schema.md). #### Defined in -[lib/schema/schema-options.ts:7](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/schema-options.ts#L7) +[lib/schema/options/schema-options.ts:9](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/options/schema-options.ts#L9) ___ @@ -237,7 +249,7 @@ The type of data structure in Redis to map objects to. #### Defined in -[lib/client.ts:21](https://github.com/redis/redis-om-node/blob/0843d26/lib/client.ts#L21) +[lib/client.ts:21](https://github.com/redis/redis-om-node/blob/9708a58/lib/client.ts#L21) ___ @@ -249,7 +261,7 @@ Valid values for how to use stop words for a given [Schema](classes/Schema.md). #### Defined in -[lib/schema/definition/schema-definitions.ts:92](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L92) +[lib/schema/options/stop-word-options.ts:2](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/options/stop-word-options.ts#L2) ___ @@ -281,4 +293,4 @@ A function that takes a [Search](classes/Search.md) and returns a [Search](class #### Defined in -[lib/search/search.ts:27](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L27) +[lib/search/search.ts:27](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L27) diff --git a/docs/classes/AbstractSearch.md b/docs/classes/AbstractSearch.md index 39ec9383..786753cc 100644 --- a/docs/classes/AbstractSearch.md +++ b/docs/classes/AbstractSearch.md @@ -61,7 +61,7 @@ this #### Defined in -[lib/search/search.ts:210](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L210) +[lib/search/search.ts:210](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L210) ## Methods @@ -75,7 +75,7 @@ You can specify the batch size by setting the `pageSize` property on the options: ```typescript -let entities = await repository.search().returnAll({ pageSize: 100 }); +const entities = await repository.search().returnAll({ pageSize: 100 }); ``` #### Parameters @@ -93,7 +93,7 @@ An array of [Entities](Entity.md) matching the query. #### Defined in -[lib/search/search.ts:191](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L191) +[lib/search/search.ts:191](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L191) ___ @@ -109,7 +109,7 @@ Returns the number of [Entities](Entity.md) that match this query. #### Defined in -[lib/search/search.ts:149](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L149) +[lib/search/search.ts:149](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L149) ___ @@ -125,7 +125,7 @@ Returns only the first [Entity](Entity.md) that matches this query. #### Defined in -[lib/search/search.ts:172](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L172) +[lib/search/search.ts:172](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L172) ___ @@ -149,7 +149,7 @@ The [Entity](Entity.md) with the maximal value #### Defined in -[lib/search/search.ts:141](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L141) +[lib/search/search.ts:141](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L141) ___ @@ -173,7 +173,7 @@ The [Entity](Entity.md) with the minimal value #### Defined in -[lib/search/search.ts:132](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L132) +[lib/search/search.ts:132](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L132) ___ @@ -198,7 +198,7 @@ An array of [Entities](Entity.md) matching the query. #### Defined in -[lib/search/search.ts:162](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L162) +[lib/search/search.ts:162](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L162) ___ @@ -221,7 +221,7 @@ Alias for [Search.all](Search.md#all). #### Defined in -[lib/search/search.ts:245](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L245) +[lib/search/search.ts:245](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L245) ___ @@ -237,7 +237,7 @@ Alias for [Search.count](Search.md#count). #### Defined in -[lib/search/search.ts:231](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L231) +[lib/search/search.ts:231](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L231) ___ @@ -253,7 +253,7 @@ Alias for [Search.first](Search.md#first). #### Defined in -[lib/search/search.ts:252](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L252) +[lib/search/search.ts:252](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L252) ___ @@ -275,7 +275,7 @@ Alias for [Search.max](Search.md#max). #### Defined in -[lib/search/search.ts:224](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L224) +[lib/search/search.ts:224](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L224) ___ @@ -297,7 +297,7 @@ Alias for [Search.min](Search.md#min). #### Defined in -[lib/search/search.ts:217](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L217) +[lib/search/search.ts:217](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L217) ___ @@ -320,7 +320,7 @@ Alias for [Search.page](Search.md#page). #### Defined in -[lib/search/search.ts:238](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L238) +[lib/search/search.ts:238](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L238) ___ @@ -342,7 +342,7 @@ Alias for [Search.sortAscending](Search.md#sortascending). #### Defined in -[lib/search/search.ts:84](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L84) +[lib/search/search.ts:84](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L84) ___ @@ -366,7 +366,7 @@ this #### Defined in -[lib/search/search.ts:61](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L61) +[lib/search/search.ts:61](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L61) ___ @@ -391,7 +391,7 @@ this #### Defined in -[lib/search/search.ts:94](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L94) +[lib/search/search.ts:94](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L94) ___ @@ -413,7 +413,7 @@ Alias for [Search.sortDescending](Search.md#sortdescending). #### Defined in -[lib/search/search.ts:68](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L68) +[lib/search/search.ts:68](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L68) ___ @@ -437,4 +437,4 @@ this #### Defined in -[lib/search/search.ts:77](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L77) +[lib/search/search.ts:77](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L77) diff --git a/docs/classes/Circle.md b/docs/classes/Circle.md index 77afc0fa..3d785e71 100644 --- a/docs/classes/Circle.md +++ b/docs/classes/Circle.md @@ -53,7 +53,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:150](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-point.ts#L150) +[lib/search/where-point.ts:150](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-point.ts#L150) ___ @@ -71,7 +71,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:144](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-point.ts#L144) +[lib/search/where-point.ts:144](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-point.ts#L144) ___ @@ -89,7 +89,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:138](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-point.ts#L138) +[lib/search/where-point.ts:138](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-point.ts#L138) ___ @@ -107,7 +107,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:123](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-point.ts#L123) +[lib/search/where-point.ts:123](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-point.ts#L123) ___ @@ -125,7 +125,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:129](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-point.ts#L129) +[lib/search/where-point.ts:129](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-point.ts#L129) ___ @@ -143,7 +143,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:117](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-point.ts#L117) +[lib/search/where-point.ts:117](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-point.ts#L117) ___ @@ -161,7 +161,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:96](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-point.ts#L96) +[lib/search/where-point.ts:96](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-point.ts#L96) ___ @@ -179,7 +179,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:102](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-point.ts#L102) +[lib/search/where-point.ts:102](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-point.ts#L102) ___ @@ -197,7 +197,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:108](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-point.ts#L108) +[lib/search/where-point.ts:108](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-point.ts#L108) ___ @@ -215,7 +215,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:159](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-point.ts#L159) +[lib/search/where-point.ts:159](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-point.ts#L159) ___ @@ -233,7 +233,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:165](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-point.ts#L165) +[lib/search/where-point.ts:165](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-point.ts#L165) ___ @@ -251,7 +251,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:171](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-point.ts#L171) +[lib/search/where-point.ts:171](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-point.ts#L171) ## Methods @@ -275,7 +275,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:43](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-point.ts#L43) +[lib/search/where-point.ts:43](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-point.ts#L43) ___ @@ -299,7 +299,7 @@ This instance. #### Defined in -[lib/search/where-point.ts:32](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-point.ts#L32) +[lib/search/where-point.ts:32](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-point.ts#L32) ___ @@ -324,4 +324,4 @@ This instance. #### Defined in -[lib/search/where-point.ts:87](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-point.ts#L87) +[lib/search/where-point.ts:87](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-point.ts#L87) diff --git a/docs/classes/Client.md b/docs/classes/Client.md index 467151de..6d39e7a5 100644 --- a/docs/classes/Client.md +++ b/docs/classes/Client.md @@ -7,7 +7,7 @@ connection to Redis and provide limited functionality for executing Redis comman Create a client and open it before you use it: ```typescript -let client = new Client(); +const client = new Client(); await client.open(); ``` @@ -49,22 +49,16 @@ Close the connection to Redis. #### Defined in -[lib/client.ts:127](https://github.com/redis/redis-om-node/blob/0843d26/lib/client.ts#L127) +[lib/client.ts:127](https://github.com/redis/redis-om-node/blob/9708a58/lib/client.ts#L127) ___ ### execute -▸ **execute**<`TResult`\>(`command`): `Promise`<`TResult`\> +▸ **execute**(`command`): `Promise`<`unknown`\> Execute an arbitrary Redis command. -#### Type parameters - -| Name | Description | -| :------ | :------ | -| `TResult` | Expect result type such as `string`, `string[]`, or whatever complex type Redis returns. | - #### Parameters | Name | Type | Description | @@ -73,13 +67,13 @@ Execute an arbitrary Redis command. #### Returns -`Promise`<`TResult`\> +`Promise`<`unknown`\> The raw results of calling the Redis command. #### Defined in -[lib/client.ts:100](https://github.com/redis/redis-om-node/blob/0843d26/lib/client.ts#L100) +[lib/client.ts:100](https://github.com/redis/redis-om-node/blob/9708a58/lib/client.ts#L100) ___ @@ -93,7 +87,7 @@ Creates a repository for the given schema. | Name | Type | Description | | :------ | :------ | :------ | -| `TEntity` | extends [`Entity`](Entity.md)<`TEntity`\> | The entity type for this {@lin Schema} and [Repository](Repository.md). | +| `TEntity` | extends [`Entity`](Entity.md)<`TEntity`\> | The entity type for this [Schema](Schema.md) and [Repository](Repository.md). | #### Parameters @@ -109,7 +103,7 @@ A repository for the provided schema. #### Defined in -[lib/client.ts:115](https://github.com/redis/redis-om-node/blob/0843d26/lib/client.ts#L115) +[lib/client.ts:115](https://github.com/redis/redis-om-node/blob/9708a58/lib/client.ts#L115) ___ @@ -125,7 +119,7 @@ Whether a connection is already open. #### Defined in -[lib/client.ts:225](https://github.com/redis/redis-om-node/blob/0843d26/lib/client.ts#L225) +[lib/client.ts:225](https://github.com/redis/redis-om-node/blob/9708a58/lib/client.ts#L225) ___ @@ -149,7 +143,7 @@ This [Client](Client.md) instance. #### Defined in -[lib/client.ts:86](https://github.com/redis/redis-om-node/blob/0843d26/lib/client.ts#L86) +[lib/client.ts:86](https://github.com/redis/redis-om-node/blob/9708a58/lib/client.ts#L86) ___ @@ -174,4 +168,4 @@ This [Client](Client.md) instance. #### Defined in -[lib/client.ts:75](https://github.com/redis/redis-om-node/blob/0843d26/lib/client.ts#L75) +[lib/client.ts:75](https://github.com/redis/redis-om-node/blob/9708a58/lib/client.ts#L75) diff --git a/docs/classes/Entity.md b/docs/classes/Entity.md index b8738d9c..aa4cfd0e 100644 --- a/docs/classes/Entity.md +++ b/docs/classes/Entity.md @@ -33,7 +33,7 @@ The generated entity ID. #### Defined in -[lib/entity/entity.ts:33](https://github.com/redis/redis-om-node/blob/0843d26/lib/entity/entity.ts#L33) +[lib/entity/entity.ts:38](https://github.com/redis/redis-om-node/blob/9708a58/lib/entity/entity.ts#L38) ## Accessors @@ -45,9 +45,11 @@ The generated entity ID. `string` +The keyname this [Entity](Entity.md) is stored with in Redis. + #### Defined in -[lib/entity/entity.ts:55](https://github.com/redis/redis-om-node/blob/0843d26/lib/entity/entity.ts#L55) +[lib/entity/entity.ts:74](https://github.com/redis/redis-om-node/blob/9708a58/lib/entity/entity.ts#L74) ## Methods @@ -55,10 +57,14 @@ The generated entity ID. ▸ **toJSON**(): `Record`<`string`, `any`\> +Converts this [Entity](Entity.md) to a JavaScript object suitable for stringification. + #### Returns `Record`<`string`, `any`\> +a JavaScript object. + #### Defined in -[lib/entity/entity.ts:59](https://github.com/redis/redis-om-node/blob/0843d26/lib/entity/entity.ts#L59) +[lib/entity/entity.ts:82](https://github.com/redis/redis-om-node/blob/9708a58/lib/entity/entity.ts#L82) diff --git a/docs/classes/RawSearch.md b/docs/classes/RawSearch.md index 59452f89..258b6e98 100644 --- a/docs/classes/RawSearch.md +++ b/docs/classes/RawSearch.md @@ -64,7 +64,7 @@ AbstractSearch.return #### Defined in -[lib/search/search.ts:210](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L210) +[lib/search/search.ts:210](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L210) ## Methods @@ -78,7 +78,7 @@ You can specify the batch size by setting the `pageSize` property on the options: ```typescript -let entities = await repository.search().returnAll({ pageSize: 100 }); +const entities = await repository.search().returnAll({ pageSize: 100 }); ``` #### Parameters @@ -100,7 +100,7 @@ An array of [Entities](Entity.md) matching the query. #### Defined in -[lib/search/search.ts:191](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L191) +[lib/search/search.ts:191](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L191) ___ @@ -120,7 +120,7 @@ Returns the number of [Entities](Entity.md) that match this query. #### Defined in -[lib/search/search.ts:149](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L149) +[lib/search/search.ts:149](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L149) ___ @@ -140,7 +140,7 @@ Returns only the first [Entity](Entity.md) that matches this query. #### Defined in -[lib/search/search.ts:172](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L172) +[lib/search/search.ts:172](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L172) ___ @@ -168,7 +168,7 @@ The [Entity](Entity.md) with the maximal value #### Defined in -[lib/search/search.ts:141](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L141) +[lib/search/search.ts:141](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L141) ___ @@ -196,7 +196,7 @@ The [Entity](Entity.md) with the minimal value #### Defined in -[lib/search/search.ts:132](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L132) +[lib/search/search.ts:132](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L132) ___ @@ -225,7 +225,7 @@ An array of [Entities](Entity.md) matching the query. #### Defined in -[lib/search/search.ts:162](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L162) +[lib/search/search.ts:162](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L162) ___ @@ -252,7 +252,7 @@ Alias for [Search.all](Search.md#all). #### Defined in -[lib/search/search.ts:245](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L245) +[lib/search/search.ts:245](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L245) ___ @@ -272,7 +272,7 @@ Alias for [Search.count](Search.md#count). #### Defined in -[lib/search/search.ts:231](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L231) +[lib/search/search.ts:231](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L231) ___ @@ -292,7 +292,7 @@ Alias for [Search.first](Search.md#first). #### Defined in -[lib/search/search.ts:252](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L252) +[lib/search/search.ts:252](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L252) ___ @@ -318,7 +318,7 @@ Alias for [Search.max](Search.md#max). #### Defined in -[lib/search/search.ts:224](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L224) +[lib/search/search.ts:224](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L224) ___ @@ -344,7 +344,7 @@ Alias for [Search.min](Search.md#min). #### Defined in -[lib/search/search.ts:217](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L217) +[lib/search/search.ts:217](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L217) ___ @@ -371,7 +371,7 @@ Alias for [Search.page](Search.md#page). #### Defined in -[lib/search/search.ts:238](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L238) +[lib/search/search.ts:238](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L238) ___ @@ -397,7 +397,7 @@ Alias for [Search.sortAscending](Search.md#sortascending). #### Defined in -[lib/search/search.ts:84](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L84) +[lib/search/search.ts:84](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L84) ___ @@ -425,7 +425,7 @@ this #### Defined in -[lib/search/search.ts:61](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L61) +[lib/search/search.ts:61](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L61) ___ @@ -454,7 +454,7 @@ this #### Defined in -[lib/search/search.ts:94](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L94) +[lib/search/search.ts:94](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L94) ___ @@ -480,7 +480,7 @@ Alias for [Search.sortDescending](Search.md#sortdescending). #### Defined in -[lib/search/search.ts:68](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L68) +[lib/search/search.ts:68](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L68) ___ @@ -508,4 +508,4 @@ this #### Defined in -[lib/search/search.ts:77](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L77) +[lib/search/search.ts:77](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L77) diff --git a/docs/classes/RedisError.md b/docs/classes/RedisError.md index 532a8786..17898cf5 100644 --- a/docs/classes/RedisError.md +++ b/docs/classes/RedisError.md @@ -44,7 +44,7 @@ Error.constructor #### Defined in -[lib/errors.ts:2](https://github.com/redis/redis-om-node/blob/0843d26/lib/errors.ts#L2) +[lib/errors.ts:2](https://github.com/redis/redis-om-node/blob/9708a58/lib/errors.ts#L2) ## Properties diff --git a/docs/classes/Repository.md b/docs/classes/Repository.md index 0647e933..7026b280 100644 --- a/docs/classes/Repository.md +++ b/docs/classes/Repository.md @@ -9,9 +9,9 @@ use the [Repository.fetch](Repository.md#fetch), [Repository.save](Repository.md [Repository.remove](Repository.md#remove) methods to manage your data: ```typescript -let repository = client.fetchRepository(schema); +const repository = client.fetchRepository(schema); -let foo = await repository.fetch('01FK6TCJBDK41RJ766A4SBWDJ9'); +const foo = await repository.fetch('01FK6TCJBDK41RJ766A4SBWDJ9'); foo.aString = 'bar'; foo.aBoolean = false; await repository.save(foo); @@ -21,7 +21,7 @@ Be sure to use the repository to create a new instance of an [Entity](Entity.md) you want to create before you save it: ```typescript -let foo = await repository.createEntity(); +const foo = await repository.createEntity(); foo.aString = 'bar'; foo.aBoolean = false; await repository.save(foo); @@ -32,7 +32,7 @@ first, and you need RediSearch or RedisJSON installed on your instance of Redis: ```typescript await repository.createIndex(); -let entities = await repository.search() +const entities = await repository.search() .where('aString').eq('bar') .and('aBoolean').is.false().returnAll(); ``` @@ -48,6 +48,7 @@ let entities = await repository.search() ### Properties - [client](Repository.md#client) +- [schema](Repository.md#schema) ### Methods @@ -70,7 +71,17 @@ let entities = await repository.search() #### Defined in -[lib/repository/repository.ts:56](https://github.com/redis/redis-om-node/blob/0843d26/lib/repository/repository.ts#L56) +[lib/repository/repository.ts:49](https://github.com/redis/redis-om-node/blob/9708a58/lib/repository/repository.ts#L49) + +___ + +### schema + +• `Protected` **schema**: [`Schema`](Schema.md)<`TEntity`\> + +#### Defined in + +[lib/repository/repository.ts:50](https://github.com/redis/redis-om-node/blob/9708a58/lib/repository/repository.ts#L50) ## Methods @@ -85,7 +96,7 @@ Creates and saves an [Entity](Entity.md). Equivalent of calling | Name | Type | Description | | :------ | :------ | :------ | -| `data` | [`EntityCreationData`](../README.md#entitycreationdata) | Optional values with which to initialize the entity. | +| `data` | [`EntityData`](../README.md#entitydata) | Optional values with which to initialize the entity. | #### Returns @@ -95,7 +106,7 @@ The newly created and saved Entity. #### Defined in -[lib/repository/repository.ts:150](https://github.com/redis/redis-om-node/blob/0843d26/lib/repository/repository.ts#L150) +[lib/repository/repository.ts:130](https://github.com/redis/redis-om-node/blob/9708a58/lib/repository/repository.ts#L130) ___ @@ -109,7 +120,7 @@ Creates an [Entity](Entity.md) with a populated [Entity.entityId](Entity.md#enti | Name | Type | Description | | :------ | :------ | :------ | -| `data` | [`EntityCreationData`](../README.md#entitycreationdata) | Optional values with which to initialize the entity. | +| `data` | [`EntityData`](../README.md#entitydata) | Optional values with which to initialize the entity. | #### Returns @@ -119,7 +130,7 @@ A newly created Entity. #### Defined in -[lib/repository/repository.ts:115](https://github.com/redis/redis-om-node/blob/0843d26/lib/repository/repository.ts#L115) +[lib/repository/repository.ts:108](https://github.com/redis/redis-om-node/blob/9708a58/lib/repository/repository.ts#L108) ___ @@ -136,7 +147,7 @@ that RediSearch or RedisJSON is installed on your instance of Redis. #### Defined in -[lib/repository/repository.ts:69](https://github.com/redis/redis-om-node/blob/0843d26/lib/repository/repository.ts#L69) +[lib/repository/repository.ts:62](https://github.com/redis/redis-om-node/blob/9708a58/lib/repository/repository.ts#L62) ___ @@ -154,7 +165,7 @@ on your instance of Redis. #### Defined in -[lib/repository/repository.ts:97](https://github.com/redis/redis-om-node/blob/0843d26/lib/repository/repository.ts#L97) +[lib/repository/repository.ts:90](https://github.com/redis/redis-om-node/blob/9708a58/lib/repository/repository.ts#L90) ___ @@ -178,7 +189,7 @@ found, does nothing. #### Defined in -[lib/repository/repository.ts:185](https://github.com/redis/redis-om-node/blob/0843d26/lib/repository/repository.ts#L185) +[lib/repository/repository.ts:163](https://github.com/redis/redis-om-node/blob/9708a58/lib/repository/repository.ts#L163) ___ @@ -204,7 +215,7 @@ The matching Entity. #### Defined in -[lib/repository/repository.ts:163](https://github.com/redis/redis-om-node/blob/0843d26/lib/repository/repository.ts#L163) +[lib/repository/repository.ts:143](https://github.com/redis/redis-om-node/blob/9708a58/lib/repository/repository.ts#L143) ___ @@ -227,7 +238,7 @@ not found, does nothing. #### Defined in -[lib/repository/repository.ts:174](https://github.com/redis/redis-om-node/blob/0843d26/lib/repository/repository.ts#L174) +[lib/repository/repository.ts:152](https://github.com/redis/redis-om-node/blob/9708a58/lib/repository/repository.ts#L152) ___ @@ -252,7 +263,7 @@ The ID of the Entity just saved. #### Defined in -[lib/repository/repository.ts:132](https://github.com/redis/redis-om-node/blob/0843d26/lib/repository/repository.ts#L132) +[lib/repository/repository.ts:119](https://github.com/redis/redis-om-node/blob/9708a58/lib/repository/repository.ts#L119) ___ @@ -271,7 +282,7 @@ A [Search](Search.md) object. #### Defined in -[lib/repository/repository.ts:196](https://github.com/redis/redis-om-node/blob/0843d26/lib/repository/repository.ts#L196) +[lib/repository/repository.ts:174](https://github.com/redis/redis-om-node/blob/9708a58/lib/repository/repository.ts#L174) ___ @@ -299,4 +310,4 @@ A [RawSearch](RawSearch.md) object. #### Defined in -[lib/repository/repository.ts:208](https://github.com/redis/redis-om-node/blob/0843d26/lib/repository/repository.ts#L208) +[lib/repository/repository.ts:186](https://github.com/redis/redis-om-node/blob/9708a58/lib/repository/repository.ts#L186) diff --git a/docs/classes/Schema.md b/docs/classes/Schema.md index 5d318b44..4381fbf0 100644 --- a/docs/classes/Schema.md +++ b/docs/classes/Schema.md @@ -7,14 +7,14 @@ data structures. Construct by passing in an [EntityConstructor](../README.md#ent a [SchemaDefinition](../README.md#schemadefinition), and optionally [SchemaOptions](../README.md#schemaoptions): ```typescript -let schema = new Schema(Foo, { +const schema = new Schema(Foo, { aString: { type: 'string' }, aNumber: { type: 'number' }, aBoolean: { type: 'boolean' }, someText: { type: 'text' }, aPoint: { type: 'point' }, aDate: { type: 'date' }, - someStrings: { type: 'string[]' } + someStrings: { type: 'array' } }, { dataStructure: 'HASH' }); @@ -71,24 +71,24 @@ its constructor. #### Defined in -[lib/schema/schema.ts:58](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/schema.ts#L58) +[lib/schema/schema.ts:62](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/schema.ts#L62) ## Accessors ### dataStructure -• `get` **dataStructure**(): [`SearchDataStructure`](../README.md#searchdatastructure) +• `get` **dataStructure**(): [`DataStructure`](../README.md#datastructure) The configured data structure, a string with the value of either `HASH` or `JSON`, that this Schema uses to store [Entities](Entity.md) in Redis. #### Returns -[`SearchDataStructure`](../README.md#searchdatastructure) +[`DataStructure`](../README.md#datastructure) #### Defined in -[lib/schema/schema.ts:80](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/schema.ts#L80) +[lib/schema/schema.ts:84](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/schema.ts#L84) ___ @@ -104,7 +104,7 @@ The hash value of this index. Stored in Redis under [Schema.indexHashName](Schem #### Defined in -[lib/schema/schema.ts:96](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/schema.ts#L96) +[lib/schema/schema.ts:100](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/schema.ts#L100) ___ @@ -120,7 +120,7 @@ The configured name for the RediSearch index hash for this Schema. #### Defined in -[lib/schema/schema.ts:74](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/schema.ts#L74) +[lib/schema/schema.ts:78](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/schema.ts#L78) ___ @@ -136,7 +136,7 @@ The configured name for the RediSearch index for this Schema. #### Defined in -[lib/schema/schema.ts:71](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/schema.ts#L71) +[lib/schema/schema.ts:75](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/schema.ts#L75) ___ @@ -152,7 +152,7 @@ The configured keyspace prefix in Redis for this Schema. #### Defined in -[lib/schema/schema.ts:68](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/schema.ts#L68) +[lib/schema/schema.ts:72](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/schema.ts#L72) ___ @@ -169,7 +169,7 @@ than `CUSTOM`. #### Defined in -[lib/schema/schema.ts:93](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/schema.ts#L93) +[lib/schema/schema.ts:97](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/schema.ts#L97) ___ @@ -187,7 +187,7 @@ for more details. #### Defined in -[lib/schema/schema.ts:87](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/schema.ts#L87) +[lib/schema/schema.ts:91](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/schema.ts#L91) ## Methods @@ -203,4 +203,4 @@ Generates a unique string using the configured [IdStrategy](../README.md#idstrat #### Defined in -[lib/schema/schema.ts:118](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/schema.ts#L118) +[lib/schema/schema.ts:126](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/schema.ts#L126) diff --git a/docs/classes/Search.md b/docs/classes/Search.md index e4546765..f379ba97 100644 --- a/docs/classes/Search.md +++ b/docs/classes/Search.md @@ -66,7 +66,7 @@ AbstractSearch.return #### Defined in -[lib/search/search.ts:210](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L210) +[lib/search/search.ts:210](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L210) ## Methods @@ -80,7 +80,7 @@ You can specify the batch size by setting the `pageSize` property on the options: ```typescript -let entities = await repository.search().returnAll({ pageSize: 100 }); +const entities = await repository.search().returnAll({ pageSize: 100 }); ``` #### Parameters @@ -102,7 +102,7 @@ An array of [Entities](Entity.md) matching the query. #### Defined in -[lib/search/search.ts:191](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L191) +[lib/search/search.ts:191](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L191) ___ @@ -126,7 +126,7 @@ A subclass of [WhereField](WhereField.md) matching the type of the field. #### Defined in -[lib/search/search.ts:340](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L340) +[lib/search/search.ts:340](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L340) ▸ **and**(`subSearchFn`): [`Search`](Search.md)<`TEntity`\> @@ -146,7 +146,7 @@ Sets up a nested search as a logical AND. #### Defined in -[lib/search/search.ts:347](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L347) +[lib/search/search.ts:347](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L347) ___ @@ -166,7 +166,7 @@ Returns the number of [Entities](Entity.md) that match this query. #### Defined in -[lib/search/search.ts:149](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L149) +[lib/search/search.ts:149](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L149) ___ @@ -186,7 +186,7 @@ Returns only the first [Entity](Entity.md) that matches this query. #### Defined in -[lib/search/search.ts:172](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L172) +[lib/search/search.ts:172](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L172) ___ @@ -214,7 +214,7 @@ The [Entity](Entity.md) with the maximal value #### Defined in -[lib/search/search.ts:141](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L141) +[lib/search/search.ts:141](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L141) ___ @@ -242,7 +242,7 @@ The [Entity](Entity.md) with the minimal value #### Defined in -[lib/search/search.ts:132](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L132) +[lib/search/search.ts:132](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L132) ___ @@ -266,7 +266,7 @@ A subclass of [WhereField](WhereField.md) matching the type of the field. #### Defined in -[lib/search/search.ts:357](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L357) +[lib/search/search.ts:357](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L357) ▸ **or**(`subSearchFn`): [`Search`](Search.md)<`TEntity`\> @@ -286,7 +286,7 @@ Sets up a nested search as a logical OR. #### Defined in -[lib/search/search.ts:364](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L364) +[lib/search/search.ts:364](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L364) ___ @@ -315,7 +315,7 @@ An array of [Entities](Entity.md) matching the query. #### Defined in -[lib/search/search.ts:162](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L162) +[lib/search/search.ts:162](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L162) ___ @@ -342,7 +342,7 @@ Alias for [Search.all](Search.md#all). #### Defined in -[lib/search/search.ts:245](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L245) +[lib/search/search.ts:245](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L245) ___ @@ -362,7 +362,7 @@ Alias for [Search.count](Search.md#count). #### Defined in -[lib/search/search.ts:231](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L231) +[lib/search/search.ts:231](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L231) ___ @@ -382,7 +382,7 @@ Alias for [Search.first](Search.md#first). #### Defined in -[lib/search/search.ts:252](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L252) +[lib/search/search.ts:252](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L252) ___ @@ -408,7 +408,7 @@ Alias for [Search.max](Search.md#max). #### Defined in -[lib/search/search.ts:224](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L224) +[lib/search/search.ts:224](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L224) ___ @@ -434,7 +434,7 @@ Alias for [Search.min](Search.md#min). #### Defined in -[lib/search/search.ts:217](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L217) +[lib/search/search.ts:217](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L217) ___ @@ -461,7 +461,7 @@ Alias for [Search.page](Search.md#page). #### Defined in -[lib/search/search.ts:238](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L238) +[lib/search/search.ts:238](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L238) ___ @@ -487,7 +487,7 @@ Alias for [Search.sortAscending](Search.md#sortascending). #### Defined in -[lib/search/search.ts:84](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L84) +[lib/search/search.ts:84](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L84) ___ @@ -515,7 +515,7 @@ this #### Defined in -[lib/search/search.ts:61](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L61) +[lib/search/search.ts:61](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L61) ___ @@ -544,7 +544,7 @@ this #### Defined in -[lib/search/search.ts:94](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L94) +[lib/search/search.ts:94](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L94) ___ @@ -570,7 +570,7 @@ Alias for [Search.sortDescending](Search.md#sortdescending). #### Defined in -[lib/search/search.ts:68](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L68) +[lib/search/search.ts:68](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L68) ___ @@ -598,7 +598,7 @@ this #### Defined in -[lib/search/search.ts:77](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L77) +[lib/search/search.ts:77](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L77) ___ @@ -623,7 +623,7 @@ A subclass of [WhereField](WhereField.md) matching the type of the field. #### Defined in -[lib/search/search.ts:322](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L322) +[lib/search/search.ts:322](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L322) ▸ **where**(`subSearchFn`): [`Search`](Search.md)<`TEntity`\> @@ -644,4 +644,4 @@ they are treated logically as AND. #### Defined in -[lib/search/search.ts:330](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/search.ts#L330) +[lib/search/search.ts:330](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/search.ts#L330) diff --git a/docs/classes/Where.md b/docs/classes/Where.md index 719a61f8..ecd99a96 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/0843d26/lib/search/where.ts#L8) +[lib/search/where.ts:8](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where.ts#L8) diff --git a/docs/classes/WhereField.md b/docs/classes/WhereField.md index 70422ca6..28298219 100644 --- a/docs/classes/WhereField.md +++ b/docs/classes/WhereField.md @@ -79,7 +79,7 @@ this multiple times will have no effect. #### Defined in -[lib/search/where-field.ts:92](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L92) +[lib/search/where-field.ts:92](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L92) ___ @@ -94,7 +94,7 @@ this multiple times will have no effect. #### Defined in -[lib/search/where-field.ts:99](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L99) +[lib/search/where-field.ts:99](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L99) ## Accessors @@ -112,7 +112,7 @@ this #### Defined in -[lib/search/where-field.ts:289](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L289) +[lib/search/where-field.ts:289](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L289) ___ @@ -130,7 +130,7 @@ this #### Defined in -[lib/search/where-field.ts:281](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L281) +[lib/search/where-field.ts:281](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L281) ___ @@ -149,7 +149,7 @@ this #### Defined in -[lib/search/where-field.ts:298](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L298) +[lib/search/where-field.ts:298](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L298) ## Methods @@ -173,7 +173,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:240](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L240) +[lib/search/where-field.ts:240](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L240) ___ @@ -197,7 +197,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:233](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L233) +[lib/search/where-field.ts:233](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L233) ___ @@ -222,7 +222,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:175](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L175) +[lib/search/where-field.ts:175](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L175) ___ @@ -246,7 +246,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:182](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L182) +[lib/search/where-field.ts:182](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L182) ___ @@ -271,7 +271,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:197](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L197) +[lib/search/where-field.ts:197](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L197) ___ @@ -295,7 +295,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:189](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L189) +[lib/search/where-field.ts:189](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L189) ___ @@ -320,7 +320,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:205](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L205) +[lib/search/where-field.ts:205](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L205) ___ @@ -347,7 +347,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:20](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L20) +[lib/search/where-field.ts:20](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L20) ___ @@ -374,7 +374,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:30](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L30) +[lib/search/where-field.ts:30](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L30) ___ @@ -401,7 +401,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:50](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L50) +[lib/search/where-field.ts:50](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L50) ___ @@ -428,7 +428,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:40](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L40) +[lib/search/where-field.ts:40](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L40) ___ @@ -446,7 +446,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:111](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L111) +[lib/search/where-field.ts:111](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L111) ___ @@ -470,7 +470,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:125](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L125) +[lib/search/where-field.ts:125](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L125) ___ @@ -494,7 +494,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:139](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L139) +[lib/search/where-field.ts:139](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L139) ___ @@ -518,7 +518,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:118](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L118) +[lib/search/where-field.ts:118](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L118) ___ @@ -542,7 +542,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:132](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L132) +[lib/search/where-field.ts:132](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L132) ___ @@ -566,7 +566,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:212](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L212) +[lib/search/where-field.ts:212](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L212) ___ @@ -590,7 +590,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:219](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L219) +[lib/search/where-field.ts:219](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L219) ___ @@ -614,7 +614,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:153](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L153) +[lib/search/where-field.ts:153](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L153) ___ @@ -638,7 +638,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:167](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L167) +[lib/search/where-field.ts:167](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L167) ___ @@ -662,7 +662,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:146](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L146) +[lib/search/where-field.ts:146](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L146) ___ @@ -686,7 +686,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:160](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L160) +[lib/search/where-field.ts:160](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L160) ___ @@ -710,7 +710,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:57](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L57) +[lib/search/where-field.ts:57](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L57) ___ @@ -734,7 +734,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:71](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L71) +[lib/search/where-field.ts:71](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L71) ___ @@ -758,7 +758,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:78](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L78) +[lib/search/where-field.ts:78](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L78) ___ @@ -782,7 +782,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:64](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L64) +[lib/search/where-field.ts:64](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L64) ___ @@ -806,7 +806,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:85](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L85) +[lib/search/where-field.ts:85](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L85) ___ @@ -830,7 +830,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:226](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L226) +[lib/search/where-field.ts:226](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L226) ___ @@ -854,7 +854,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:254](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L254) +[lib/search/where-field.ts:254](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L254) ___ @@ -878,7 +878,7 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:247](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L247) +[lib/search/where-field.ts:247](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L247) ___ @@ -898,7 +898,7 @@ Converts this [Where](Where.md) into a portion of a RediSearch query. #### Defined in -[lib/search/where-field.ts:303](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L303) +[lib/search/where-field.ts:303](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L303) ___ @@ -916,4 +916,4 @@ The [Search](Search.md) that was called to create this [WhereField](WhereField.m #### Defined in -[lib/search/where-field.ts:105](https://github.com/redis/redis-om-node/blob/0843d26/lib/search/where-field.ts#L105) +[lib/search/where-field.ts:105](https://github.com/redis/redis-om-node/blob/9708a58/lib/search/where-field.ts#L105) diff --git a/docs/interfaces/BaseFieldDefinition.md b/docs/interfaces/BaseFieldDefinition.md new file mode 100644 index 00000000..4b550eca --- /dev/null +++ b/docs/interfaces/BaseFieldDefinition.md @@ -0,0 +1,55 @@ +[redis-om](../README.md) / BaseFieldDefinition + +# Interface: BaseFieldDefinition + +Base interface for all fields. + +## Hierarchy + +- **`BaseFieldDefinition`** + + ↳ [`BooleanFieldDefinition`](BooleanFieldDefinition.md) + + ↳ [`DateFieldDefinition`](DateFieldDefinition.md) + + ↳ [`NumberFieldDefinition`](NumberFieldDefinition.md) + + ↳ [`PointFieldDefinition`](PointFieldDefinition.md) + + ↳ [`StringFieldDefinition`](StringFieldDefinition.md) + + ↳ [`StringArrayFieldDefinition`](StringArrayFieldDefinition.md) + + ↳ [`TextFieldDefinition`](TextFieldDefinition.md) + +## Table of contents + +### Properties + +- [alias](BaseFieldDefinition.md#alias) +- [type](BaseFieldDefinition.md#type) + +## Properties + +### alias + +• `Optional` **alias**: `string` + +The default field name in Redis is the key name defined in the +[SchemaDefinition](../README.md#schemadefinition). Overrides the Redis key name if set. + +#### Defined in + +[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/base-field-definition.ts#L12) + +___ + +### type + +• **type**: [`SchemaFieldType`](../README.md#schemafieldtype) + +The type of the field (i.e. string, number, boolean, etc.) + +#### Defined in + +[lib/schema/definition/base-field-definition.ts:6](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/base-field-definition.ts#L6) diff --git a/docs/interfaces/BooleanField.md b/docs/interfaces/BooleanField.md deleted file mode 100644 index b3ef8aa2..00000000 --- a/docs/interfaces/BooleanField.md +++ /dev/null @@ -1,70 +0,0 @@ -[redis-om](../README.md) / BooleanField - -# Interface: BooleanField - -A field representing a boolean. - -## Hierarchy - -- [`Field`](Field.md) - -- [`Sortable`](Sortable.md) - - ↳ **`BooleanField`** - -## Table of contents - -### Properties - -- [alias](BooleanField.md#alias) -- [sortable](BooleanField.md#sortable) -- [type](BooleanField.md#type) - -## Properties - -### alias - -• `Optional` **alias**: `string` - -The default field name in Redis is the key name defined in the -[SchemaDefinition](../README.md#schemadefinition). Overrides the Redis key name if set. - -#### Inherited from - -[Field](Field.md).[alias](Field.md#alias) - -#### Defined in - -[lib/schema/definition/schema-definitions.ts:18](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L18) - -___ - -### sortable - -• `Optional` **sortable**: `boolean` - -Enables sorting by this field. - -#### Inherited from - -[Sortable](Sortable.md).[sortable](Sortable.md#sortable) - -#### Defined in - -[lib/schema/definition/schema-definitions.ts:24](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L24) - -___ - -### type - -• **type**: ``"boolean"`` - -Yep. It's a boolean. - -#### Overrides - -[Field](Field.md).[type](Field.md#type) - -#### Defined in - -[lib/schema/definition/schema-definitions.ts:59](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L59) diff --git a/docs/interfaces/BooleanFieldDefinition.md b/docs/interfaces/BooleanFieldDefinition.md new file mode 100644 index 00000000..e7b0c83c --- /dev/null +++ b/docs/interfaces/BooleanFieldDefinition.md @@ -0,0 +1,70 @@ +[redis-om](../README.md) / BooleanFieldDefinition + +# Interface: BooleanFieldDefinition + +A field representing a boolean. + +## Hierarchy + +- [`BaseFieldDefinition`](BaseFieldDefinition.md) + +- [`SortableFieldDefinition`](SortableFieldDefinition.md) + + ↳ **`BooleanFieldDefinition`** + +## Table of contents + +### Properties + +- [alias](BooleanFieldDefinition.md#alias) +- [sortable](BooleanFieldDefinition.md#sortable) +- [type](BooleanFieldDefinition.md#type) + +## Properties + +### alias + +• `Optional` **alias**: `string` + +The default field name in Redis is the key name defined in the +[SchemaDefinition](../README.md#schemadefinition). Overrides the Redis key name if set. + +#### Inherited from + +[BaseFieldDefinition](BaseFieldDefinition.md).[alias](BaseFieldDefinition.md#alias) + +#### Defined in + +[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/base-field-definition.ts#L12) + +___ + +### sortable + +• `Optional` **sortable**: `boolean` + +Enables sorting by this field. + +#### Inherited from + +[SortableFieldDefinition](SortableFieldDefinition.md).[sortable](SortableFieldDefinition.md#sortable) + +#### Defined in + +[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/sortable-field-definition.ts#L4) + +___ + +### type + +• **type**: ``"boolean"`` + +Yep. It's a boolean. + +#### Overrides + +[BaseFieldDefinition](BaseFieldDefinition.md).[type](BaseFieldDefinition.md#type) + +#### Defined in + +[lib/schema/definition/boolean-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/boolean-field-definition.ts#L7) diff --git a/docs/interfaces/DateField.md b/docs/interfaces/DateField.md deleted file mode 100644 index 886d550c..00000000 --- a/docs/interfaces/DateField.md +++ /dev/null @@ -1,70 +0,0 @@ -[redis-om](../README.md) / DateField - -# Interface: DateField - -A field representing a date/time. - -## Hierarchy - -- [`Field`](Field.md) - -- [`Sortable`](Sortable.md) - - ↳ **`DateField`** - -## Table of contents - -### Properties - -- [alias](DateField.md#alias) -- [sortable](DateField.md#sortable) -- [type](DateField.md#type) - -## Properties - -### alias - -• `Optional` **alias**: `string` - -The default field name in Redis is the key name defined in the -[SchemaDefinition](../README.md#schemadefinition). Overrides the Redis key name if set. - -#### Inherited from - -[Field](Field.md).[alias](Field.md#alias) - -#### Defined in - -[lib/schema/definition/schema-definitions.ts:18](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L18) - -___ - -### sortable - -• `Optional` **sortable**: `boolean` - -Enables sorting by this field. - -#### Inherited from - -[Sortable](Sortable.md).[sortable](Sortable.md#sortable) - -#### Defined in - -[lib/schema/definition/schema-definitions.ts:24](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L24) - -___ - -### type - -• **type**: ``"date"`` - -Yep. It's a date. - -#### Overrides - -[Field](Field.md).[type](Field.md#type) - -#### Defined in - -[lib/schema/definition/schema-definitions.ts:71](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L71) diff --git a/docs/interfaces/DateFieldDefinition.md b/docs/interfaces/DateFieldDefinition.md new file mode 100644 index 00000000..ac81d982 --- /dev/null +++ b/docs/interfaces/DateFieldDefinition.md @@ -0,0 +1,70 @@ +[redis-om](../README.md) / DateFieldDefinition + +# Interface: DateFieldDefinition + +A field representing a date/time. + +## Hierarchy + +- [`BaseFieldDefinition`](BaseFieldDefinition.md) + +- [`SortableFieldDefinition`](SortableFieldDefinition.md) + + ↳ **`DateFieldDefinition`** + +## Table of contents + +### Properties + +- [alias](DateFieldDefinition.md#alias) +- [sortable](DateFieldDefinition.md#sortable) +- [type](DateFieldDefinition.md#type) + +## Properties + +### alias + +• `Optional` **alias**: `string` + +The default field name in Redis is the key name defined in the +[SchemaDefinition](../README.md#schemadefinition). Overrides the Redis key name if set. + +#### Inherited from + +[BaseFieldDefinition](BaseFieldDefinition.md).[alias](BaseFieldDefinition.md#alias) + +#### Defined in + +[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/base-field-definition.ts#L12) + +___ + +### sortable + +• `Optional` **sortable**: `boolean` + +Enables sorting by this field. + +#### Inherited from + +[SortableFieldDefinition](SortableFieldDefinition.md).[sortable](SortableFieldDefinition.md#sortable) + +#### Defined in + +[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/sortable-field-definition.ts#L4) + +___ + +### type + +• **type**: ``"date"`` + +Yep. It's a date. + +#### Overrides + +[BaseFieldDefinition](BaseFieldDefinition.md).[type](BaseFieldDefinition.md#type) + +#### Defined in + +[lib/schema/definition/date-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/date-field-definition.ts#L7) diff --git a/docs/interfaces/Field.md b/docs/interfaces/Field.md deleted file mode 100644 index f85969e8..00000000 --- a/docs/interfaces/Field.md +++ /dev/null @@ -1,55 +0,0 @@ -[redis-om](../README.md) / Field - -# Interface: Field - -Base interface for all fields. - -## Hierarchy - -- **`Field`** - - ↳ [`BooleanField`](BooleanField.md) - - ↳ [`DateField`](DateField.md) - - ↳ [`NumberField`](NumberField.md) - - ↳ [`PointField`](PointField.md) - - ↳ [`StringField`](StringField.md) - - ↳ [`StringArrayField`](StringArrayField.md) - - ↳ [`TextField`](TextField.md) - -## Table of contents - -### Properties - -- [alias](Field.md#alias) -- [type](Field.md#type) - -## Properties - -### alias - -• `Optional` **alias**: `string` - -The default field name in Redis is the key name defined in the -[SchemaDefinition](../README.md#schemadefinition). Overrides the Redis key name if set. - -#### Defined in - -[lib/schema/definition/schema-definitions.ts:18](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L18) - -___ - -### type - -• **type**: `string` - -The type of the field (i.e. string, number, boolean, etc.) - -#### Defined in - -[lib/schema/definition/schema-definitions.ts:12](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L12) diff --git a/docs/interfaces/NumberField.md b/docs/interfaces/NumberField.md deleted file mode 100644 index 52bba9c6..00000000 --- a/docs/interfaces/NumberField.md +++ /dev/null @@ -1,70 +0,0 @@ -[redis-om](../README.md) / NumberField - -# Interface: NumberField - -A field representing a number. - -## Hierarchy - -- [`Field`](Field.md) - -- [`Sortable`](Sortable.md) - - ↳ **`NumberField`** - -## Table of contents - -### Properties - -- [alias](NumberField.md#alias) -- [sortable](NumberField.md#sortable) -- [type](NumberField.md#type) - -## Properties - -### alias - -• `Optional` **alias**: `string` - -The default field name in Redis is the key name defined in the -[SchemaDefinition](../README.md#schemadefinition). Overrides the Redis key name if set. - -#### Inherited from - -[Field](Field.md).[alias](Field.md#alias) - -#### Defined in - -[lib/schema/definition/schema-definitions.ts:18](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L18) - -___ - -### sortable - -• `Optional` **sortable**: `boolean` - -Enables sorting by this field. - -#### Inherited from - -[Sortable](Sortable.md).[sortable](Sortable.md#sortable) - -#### Defined in - -[lib/schema/definition/schema-definitions.ts:24](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L24) - -___ - -### type - -• **type**: ``"number"`` - -Yep. It's a number. - -#### Overrides - -[Field](Field.md).[type](Field.md#type) - -#### Defined in - -[lib/schema/definition/schema-definitions.ts:41](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L41) diff --git a/docs/interfaces/NumberFieldDefinition.md b/docs/interfaces/NumberFieldDefinition.md new file mode 100644 index 00000000..7557fa4b --- /dev/null +++ b/docs/interfaces/NumberFieldDefinition.md @@ -0,0 +1,70 @@ +[redis-om](../README.md) / NumberFieldDefinition + +# Interface: NumberFieldDefinition + +A field representing a number. + +## Hierarchy + +- [`BaseFieldDefinition`](BaseFieldDefinition.md) + +- [`SortableFieldDefinition`](SortableFieldDefinition.md) + + ↳ **`NumberFieldDefinition`** + +## Table of contents + +### Properties + +- [alias](NumberFieldDefinition.md#alias) +- [sortable](NumberFieldDefinition.md#sortable) +- [type](NumberFieldDefinition.md#type) + +## Properties + +### alias + +• `Optional` **alias**: `string` + +The default field name in Redis is the key name defined in the +[SchemaDefinition](../README.md#schemadefinition). Overrides the Redis key name if set. + +#### Inherited from + +[BaseFieldDefinition](BaseFieldDefinition.md).[alias](BaseFieldDefinition.md#alias) + +#### Defined in + +[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/base-field-definition.ts#L12) + +___ + +### sortable + +• `Optional` **sortable**: `boolean` + +Enables sorting by this field. + +#### Inherited from + +[SortableFieldDefinition](SortableFieldDefinition.md).[sortable](SortableFieldDefinition.md#sortable) + +#### Defined in + +[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/sortable-field-definition.ts#L4) + +___ + +### type + +• **type**: ``"number"`` + +Yep. It's a number. + +#### Overrides + +[BaseFieldDefinition](BaseFieldDefinition.md).[type](BaseFieldDefinition.md#type) + +#### Defined in + +[lib/schema/definition/number-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/number-field-definition.ts#L7) diff --git a/docs/interfaces/PointField.md b/docs/interfaces/PointField.md deleted file mode 100644 index 7a9d8d6e..00000000 --- a/docs/interfaces/PointField.md +++ /dev/null @@ -1,51 +0,0 @@ -[redis-om](../README.md) / PointField - -# Interface: PointField - -A field representing a point on the globe. - -## Hierarchy - -- [`Field`](Field.md) - - ↳ **`PointField`** - -## Table of contents - -### Properties - -- [alias](PointField.md#alias) -- [type](PointField.md#type) - -## Properties - -### alias - -• `Optional` **alias**: `string` - -The default field name in Redis is the key name defined in the -[SchemaDefinition](../README.md#schemadefinition). Overrides the Redis key name if set. - -#### Inherited from - -[Field](Field.md).[alias](Field.md#alias) - -#### Defined in - -[lib/schema/definition/schema-definitions.ts:18](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L18) - -___ - -### type - -• **type**: ``"point"`` - -Yep. It's a point. - -#### Overrides - -[Field](Field.md).[type](Field.md#type) - -#### Defined in - -[lib/schema/definition/schema-definitions.ts:65](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L65) diff --git a/docs/interfaces/PointFieldDefinition.md b/docs/interfaces/PointFieldDefinition.md new file mode 100644 index 00000000..6de4475c --- /dev/null +++ b/docs/interfaces/PointFieldDefinition.md @@ -0,0 +1,51 @@ +[redis-om](../README.md) / PointFieldDefinition + +# Interface: PointFieldDefinition + +A field representing a point on the globe. + +## Hierarchy + +- [`BaseFieldDefinition`](BaseFieldDefinition.md) + + ↳ **`PointFieldDefinition`** + +## Table of contents + +### Properties + +- [alias](PointFieldDefinition.md#alias) +- [type](PointFieldDefinition.md#type) + +## Properties + +### alias + +• `Optional` **alias**: `string` + +The default field name in Redis is the key name defined in the +[SchemaDefinition](../README.md#schemadefinition). Overrides the Redis key name if set. + +#### Inherited from + +[BaseFieldDefinition](BaseFieldDefinition.md).[alias](BaseFieldDefinition.md#alias) + +#### Defined in + +[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/base-field-definition.ts#L12) + +___ + +### type + +• **type**: ``"point"`` + +Yep. It's a point. + +#### Overrides + +[BaseFieldDefinition](BaseFieldDefinition.md).[type](BaseFieldDefinition.md#type) + +#### Defined in + +[lib/schema/definition/point-field-definition.ts:6](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/point-field-definition.ts#L6) diff --git a/docs/interfaces/Separable.md b/docs/interfaces/SeparableFieldDefinition.md similarity index 52% rename from docs/interfaces/Separable.md rename to docs/interfaces/SeparableFieldDefinition.md index dbadf9a9..42331328 100644 --- a/docs/interfaces/Separable.md +++ b/docs/interfaces/SeparableFieldDefinition.md @@ -1,22 +1,22 @@ -[redis-om](../README.md) / Separable +[redis-om](../README.md) / SeparableFieldDefinition -# Interface: Separable +# Interface: SeparableFieldDefinition Mixin for adding parsing for TAG fields in RediSearch. ## Hierarchy -- **`Separable`** +- **`SeparableFieldDefinition`** - ↳ [`StringField`](StringField.md) + ↳ [`StringFieldDefinition`](StringFieldDefinition.md) - ↳ [`StringArrayField`](StringArrayField.md) + ↳ [`StringArrayFieldDefinition`](StringArrayFieldDefinition.md) ## Table of contents ### Properties -- [separator](Separable.md#separator) +- [separator](SeparableFieldDefinition.md#separator) ## Properties @@ -31,4 +31,4 @@ those problems. Defaults to `|`. #### Defined in -[lib/schema/definition/schema-definitions.ts:35](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L35) +[lib/schema/definition/separable-field-definition.ts:9](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/separable-field-definition.ts#L9) diff --git a/docs/interfaces/Sortable.md b/docs/interfaces/Sortable.md deleted file mode 100644 index 283c46bd..00000000 --- a/docs/interfaces/Sortable.md +++ /dev/null @@ -1,37 +0,0 @@ -[redis-om](../README.md) / Sortable - -# Interface: Sortable - -Mixin for adding sortability to a field. - -## Hierarchy - -- **`Sortable`** - - ↳ [`BooleanField`](BooleanField.md) - - ↳ [`DateField`](DateField.md) - - ↳ [`NumberField`](NumberField.md) - - ↳ [`StringField`](StringField.md) - - ↳ [`TextField`](TextField.md) - -## Table of contents - -### Properties - -- [sortable](Sortable.md#sortable) - -## Properties - -### sortable - -• `Optional` **sortable**: `boolean` - -Enables sorting by this field. - -#### Defined in - -[lib/schema/definition/schema-definitions.ts:24](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L24) diff --git a/docs/interfaces/SortableFieldDefinition.md b/docs/interfaces/SortableFieldDefinition.md new file mode 100644 index 00000000..3c307e14 --- /dev/null +++ b/docs/interfaces/SortableFieldDefinition.md @@ -0,0 +1,37 @@ +[redis-om](../README.md) / SortableFieldDefinition + +# Interface: SortableFieldDefinition + +Mixin for adding sortability to a field. + +## Hierarchy + +- **`SortableFieldDefinition`** + + ↳ [`BooleanFieldDefinition`](BooleanFieldDefinition.md) + + ↳ [`DateFieldDefinition`](DateFieldDefinition.md) + + ↳ [`NumberFieldDefinition`](NumberFieldDefinition.md) + + ↳ [`StringFieldDefinition`](StringFieldDefinition.md) + + ↳ [`TextFieldDefinition`](TextFieldDefinition.md) + +## Table of contents + +### Properties + +- [sortable](SortableFieldDefinition.md#sortable) + +## Properties + +### sortable + +• `Optional` **sortable**: `boolean` + +Enables sorting by this field. + +#### Defined in + +[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/sortable-field-definition.ts#L4) diff --git a/docs/interfaces/StringArrayField.md b/docs/interfaces/StringArrayField.md deleted file mode 100644 index 0ff5be36..00000000 --- a/docs/interfaces/StringArrayField.md +++ /dev/null @@ -1,73 +0,0 @@ -[redis-om](../README.md) / StringArrayField - -# Interface: StringArrayField - -A field representing an array of strings. - -## Hierarchy - -- [`Field`](Field.md) - -- [`Separable`](Separable.md) - - ↳ **`StringArrayField`** - -## Table of contents - -### Properties - -- [alias](StringArrayField.md#alias) -- [separator](StringArrayField.md#separator) -- [type](StringArrayField.md#type) - -## Properties - -### alias - -• `Optional` **alias**: `string` - -The default field name in Redis is the key name defined in the -[SchemaDefinition](../README.md#schemadefinition). Overrides the Redis key name if set. - -#### Inherited from - -[Field](Field.md).[alias](Field.md#alias) - -#### Defined in - -[lib/schema/definition/schema-definitions.ts:18](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L18) - -___ - -### separator - -• `Optional` **separator**: `string` - -Due to how RediSearch works, strings and arrays are sometimes stored the same in Redis, as a -simple string. This is the separator used to split those strings when it is an array. If your -StringField contains this separator, this can cause problems. You can change it here to avoid -those problems. Defaults to `|`. - -#### Inherited from - -[Separable](Separable.md).[separator](Separable.md#separator) - -#### Defined in - -[lib/schema/definition/schema-definitions.ts:35](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L35) - -___ - -### type - -• **type**: ``"string[]"`` - -Yep. It's a string array. - -#### Overrides - -[Field](Field.md).[type](Field.md#type) - -#### Defined in - -[lib/schema/definition/schema-definitions.ts:77](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L77) diff --git a/docs/interfaces/StringArrayFieldDefinition.md b/docs/interfaces/StringArrayFieldDefinition.md new file mode 100644 index 00000000..a2080c80 --- /dev/null +++ b/docs/interfaces/StringArrayFieldDefinition.md @@ -0,0 +1,73 @@ +[redis-om](../README.md) / StringArrayFieldDefinition + +# Interface: StringArrayFieldDefinition + +A field representing an array of strings. + +## Hierarchy + +- [`BaseFieldDefinition`](BaseFieldDefinition.md) + +- [`SeparableFieldDefinition`](SeparableFieldDefinition.md) + + ↳ **`StringArrayFieldDefinition`** + +## Table of contents + +### Properties + +- [alias](StringArrayFieldDefinition.md#alias) +- [separator](StringArrayFieldDefinition.md#separator) +- [type](StringArrayFieldDefinition.md#type) + +## Properties + +### alias + +• `Optional` **alias**: `string` + +The default field name in Redis is the key name defined in the +[SchemaDefinition](../README.md#schemadefinition). Overrides the Redis key name if set. + +#### Inherited from + +[BaseFieldDefinition](BaseFieldDefinition.md).[alias](BaseFieldDefinition.md#alias) + +#### Defined in + +[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/base-field-definition.ts#L12) + +___ + +### separator + +• `Optional` **separator**: `string` + +Due to how RediSearch works, strings and arrays are sometimes stored the same in Redis, as a +simple string. This is the separator used to split those strings when it is an array. If your +StringField contains this separator, this can cause problems. You can change it here to avoid +those problems. Defaults to `|`. + +#### Inherited from + +[SeparableFieldDefinition](SeparableFieldDefinition.md).[separator](SeparableFieldDefinition.md#separator) + +#### Defined in + +[lib/schema/definition/separable-field-definition.ts:9](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/separable-field-definition.ts#L9) + +___ + +### type + +• **type**: ``"array"`` + +Yep. It's a string array. + +#### Overrides + +[BaseFieldDefinition](BaseFieldDefinition.md).[type](BaseFieldDefinition.md#type) + +#### Defined in + +[lib/schema/definition/string-array-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/string-array-field-definition.ts#L7) diff --git a/docs/interfaces/StringField.md b/docs/interfaces/StringField.md deleted file mode 100644 index d6463d13..00000000 --- a/docs/interfaces/StringField.md +++ /dev/null @@ -1,92 +0,0 @@ -[redis-om](../README.md) / StringField - -# Interface: StringField - -A field representing a whole string. - -## Hierarchy - -- [`Field`](Field.md) - -- [`Sortable`](Sortable.md) - -- [`Separable`](Separable.md) - - ↳ **`StringField`** - -## Table of contents - -### Properties - -- [alias](StringField.md#alias) -- [separator](StringField.md#separator) -- [sortable](StringField.md#sortable) -- [type](StringField.md#type) - -## Properties - -### alias - -• `Optional` **alias**: `string` - -The default field name in Redis is the key name defined in the -[SchemaDefinition](../README.md#schemadefinition). Overrides the Redis key name if set. - -#### Inherited from - -[Field](Field.md).[alias](Field.md#alias) - -#### Defined in - -[lib/schema/definition/schema-definitions.ts:18](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L18) - -___ - -### separator - -• `Optional` **separator**: `string` - -Due to how RediSearch works, strings and arrays are sometimes stored the same in Redis, as a -simple string. This is the separator used to split those strings when it is an array. If your -StringField contains this separator, this can cause problems. You can change it here to avoid -those problems. Defaults to `|`. - -#### Inherited from - -[Separable](Separable.md).[separator](Separable.md#separator) - -#### Defined in - -[lib/schema/definition/schema-definitions.ts:35](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L35) - -___ - -### sortable - -• `Optional` **sortable**: `boolean` - -Enables sorting by this field. - -#### Inherited from - -[Sortable](Sortable.md).[sortable](Sortable.md#sortable) - -#### Defined in - -[lib/schema/definition/schema-definitions.ts:24](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L24) - -___ - -### type - -• **type**: ``"string"`` - -Yep. It's a string. - -#### Overrides - -[Field](Field.md).[type](Field.md#type) - -#### Defined in - -[lib/schema/definition/schema-definitions.ts:47](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L47) diff --git a/docs/interfaces/StringFieldDefinition.md b/docs/interfaces/StringFieldDefinition.md new file mode 100644 index 00000000..1b408fb4 --- /dev/null +++ b/docs/interfaces/StringFieldDefinition.md @@ -0,0 +1,92 @@ +[redis-om](../README.md) / StringFieldDefinition + +# Interface: StringFieldDefinition + +A field representing a whole string. + +## Hierarchy + +- [`BaseFieldDefinition`](BaseFieldDefinition.md) + +- [`SortableFieldDefinition`](SortableFieldDefinition.md) + +- [`SeparableFieldDefinition`](SeparableFieldDefinition.md) + + ↳ **`StringFieldDefinition`** + +## Table of contents + +### Properties + +- [alias](StringFieldDefinition.md#alias) +- [separator](StringFieldDefinition.md#separator) +- [sortable](StringFieldDefinition.md#sortable) +- [type](StringFieldDefinition.md#type) + +## Properties + +### alias + +• `Optional` **alias**: `string` + +The default field name in Redis is the key name defined in the +[SchemaDefinition](../README.md#schemadefinition). Overrides the Redis key name if set. + +#### Inherited from + +[BaseFieldDefinition](BaseFieldDefinition.md).[alias](BaseFieldDefinition.md#alias) + +#### Defined in + +[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/base-field-definition.ts#L12) + +___ + +### separator + +• `Optional` **separator**: `string` + +Due to how RediSearch works, strings and arrays are sometimes stored the same in Redis, as a +simple string. This is the separator used to split those strings when it is an array. If your +StringField contains this separator, this can cause problems. You can change it here to avoid +those problems. Defaults to `|`. + +#### Inherited from + +[SeparableFieldDefinition](SeparableFieldDefinition.md).[separator](SeparableFieldDefinition.md#separator) + +#### Defined in + +[lib/schema/definition/separable-field-definition.ts:9](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/separable-field-definition.ts#L9) + +___ + +### sortable + +• `Optional` **sortable**: `boolean` + +Enables sorting by this field. + +#### Inherited from + +[SortableFieldDefinition](SortableFieldDefinition.md).[sortable](SortableFieldDefinition.md#sortable) + +#### Defined in + +[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/sortable-field-definition.ts#L4) + +___ + +### type + +• **type**: ``"string"`` + +Yep. It's a string. + +#### Overrides + +[BaseFieldDefinition](BaseFieldDefinition.md).[type](BaseFieldDefinition.md#type) + +#### Defined in + +[lib/schema/definition/string-field-definition.ts:8](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/string-field-definition.ts#L8) diff --git a/docs/interfaces/TextField.md b/docs/interfaces/TextField.md deleted file mode 100644 index 6af42225..00000000 --- a/docs/interfaces/TextField.md +++ /dev/null @@ -1,70 +0,0 @@ -[redis-om](../README.md) / TextField - -# Interface: TextField - -A field representing searchable text. - -## Hierarchy - -- [`Field`](Field.md) - -- [`Sortable`](Sortable.md) - - ↳ **`TextField`** - -## Table of contents - -### Properties - -- [alias](TextField.md#alias) -- [sortable](TextField.md#sortable) -- [type](TextField.md#type) - -## Properties - -### alias - -• `Optional` **alias**: `string` - -The default field name in Redis is the key name defined in the -[SchemaDefinition](../README.md#schemadefinition). Overrides the Redis key name if set. - -#### Inherited from - -[Field](Field.md).[alias](Field.md#alias) - -#### Defined in - -[lib/schema/definition/schema-definitions.ts:18](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L18) - -___ - -### sortable - -• `Optional` **sortable**: `boolean` - -Enables sorting by this field. - -#### Inherited from - -[Sortable](Sortable.md).[sortable](Sortable.md#sortable) - -#### Defined in - -[lib/schema/definition/schema-definitions.ts:24](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L24) - -___ - -### type - -• **type**: ``"text"`` - -Yep. It's searchable text. - -#### Overrides - -[Field](Field.md).[type](Field.md#type) - -#### Defined in - -[lib/schema/definition/schema-definitions.ts:53](https://github.com/redis/redis-om-node/blob/0843d26/lib/schema/definition/schema-definitions.ts#L53) diff --git a/docs/interfaces/TextFieldDefinition.md b/docs/interfaces/TextFieldDefinition.md new file mode 100644 index 00000000..b888c40a --- /dev/null +++ b/docs/interfaces/TextFieldDefinition.md @@ -0,0 +1,70 @@ +[redis-om](../README.md) / TextFieldDefinition + +# Interface: TextFieldDefinition + +A field representing searchable text. + +## Hierarchy + +- [`BaseFieldDefinition`](BaseFieldDefinition.md) + +- [`SortableFieldDefinition`](SortableFieldDefinition.md) + + ↳ **`TextFieldDefinition`** + +## Table of contents + +### Properties + +- [alias](TextFieldDefinition.md#alias) +- [sortable](TextFieldDefinition.md#sortable) +- [type](TextFieldDefinition.md#type) + +## Properties + +### alias + +• `Optional` **alias**: `string` + +The default field name in Redis is the key name defined in the +[SchemaDefinition](../README.md#schemadefinition). Overrides the Redis key name if set. + +#### Inherited from + +[BaseFieldDefinition](BaseFieldDefinition.md).[alias](BaseFieldDefinition.md#alias) + +#### Defined in + +[lib/schema/definition/base-field-definition.ts:12](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/base-field-definition.ts#L12) + +___ + +### sortable + +• `Optional` **sortable**: `boolean` + +Enables sorting by this field. + +#### Inherited from + +[SortableFieldDefinition](SortableFieldDefinition.md).[sortable](SortableFieldDefinition.md#sortable) + +#### Defined in + +[lib/schema/definition/sortable-field-definition.ts:4](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/sortable-field-definition.ts#L4) + +___ + +### type + +• **type**: ``"text"`` + +Yep. It's searchable text. + +#### Overrides + +[BaseFieldDefinition](BaseFieldDefinition.md).[type](BaseFieldDefinition.md#type) + +#### Defined in + +[lib/schema/definition/text-field-definition.ts:7](https://github.com/redis/redis-om-node/blob/9708a58/lib/schema/definition/text-field-definition.ts#L7) diff --git a/lib/index.ts b/lib/index.ts index 1a35e928..58e7ef75 100644 --- a/lib/index.ts +++ b/lib/index.ts @@ -10,6 +10,7 @@ import Schema from "./schema/schema"; import SchemaDefinition from "./schema/definition/schema-definition"; import FieldDefinition from "./schema/definition/field-definition"; import BaseFieldDefinition from "./schema/definition/base-field-definition"; +import SchemaFieldType from "./schema/definition/schema-field-type"; import SortableFieldDefinition from "./schema/definition/sortable-field-definition"; import SeparableFieldDefinition from "./schema/definition/separable-field-definition"; import StringFieldDefinition from "./schema/definition/string-field-definition"; @@ -39,9 +40,12 @@ export { Entity, EntityData, EntityValue, EntityConstructor, RedisError, Repository, Schema, SchemaDefinition, Point, - FieldDefinition as FieldDefinition, + FieldDefinition, SchemaOptions, DataStructure, IdStrategy, StopWordOptions, - BaseFieldDefinition as Field, SortableFieldDefinition as Sortable, SeparableFieldDefinition as Separable, BooleanFieldDefinition as BooleanField, DateFieldDefinition as DateField, NumberFieldDefinition as NumberField, PointFieldDefinition as PointField, StringFieldDefinition as StringField, StringArrayFieldDefinition as StringArrayField, TextFieldDefinition as TextField, + BaseFieldDefinition, SortableFieldDefinition, SeparableFieldDefinition, + BooleanFieldDefinition, DateFieldDefinition, NumberFieldDefinition, + PointFieldDefinition, StringFieldDefinition, StringArrayFieldDefinition, + TextFieldDefinition, SchemaFieldType, AbstractSearch, Search, RawSearch, SubSearchFunction, Where, WhereField, Circle, CircleFunction }; diff --git a/lib/schema/definition/schema-definition.ts b/lib/schema/definition/schema-definition.ts index 044edbf9..29daa241 100644 --- a/lib/schema/definition/schema-definition.ts +++ b/lib/schema/definition/schema-definition.ts @@ -1,7 +1,3 @@ -import BaseFieldDefinition from "./base-field-definition"; -import SeparableFieldDefinition from "./separable-field-definition"; -import SortableFieldDefinition from "./sortable-field-definition"; - import FieldDefinition from "./field-definition"; /** diff --git a/package-lock.json b/package-lock.json index ee0acb70..e24c4947 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,11 @@ { "name": "redis-om", - "version": "0.2.1", + "version": "0.3.0", "lockfileVersion": 2, "requires": true, "packages": { "": { - "name": "redis-om", - "version": "0.2.1", + "version": "0.3.0", "license": "MIT", "dependencies": { "redis": "^4.0.4", @@ -85,10 +84,6 @@ }, "engines": { "node": ">=6.9.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/babel" } }, "node_modules/@babel/generator": { @@ -127,9 +122,6 @@ }, "engines": { "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" } }, "node_modules/@babel/helper-environment-visitor": { @@ -382,9 +374,6 @@ "dev": true, "dependencies": { "@babel/helper-plugin-utils": "^7.8.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" } }, "node_modules/@babel/plugin-syntax-bigint": { @@ -394,9 +383,6 @@ "dev": true, "dependencies": { "@babel/helper-plugin-utils": "^7.8.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" } }, "node_modules/@babel/plugin-syntax-class-properties": { @@ -406,9 +392,6 @@ "dev": true, "dependencies": { "@babel/helper-plugin-utils": "^7.12.13" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" } }, "node_modules/@babel/plugin-syntax-import-meta": { @@ -418,9 +401,6 @@ "dev": true, "dependencies": { "@babel/helper-plugin-utils": "^7.10.4" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" } }, "node_modules/@babel/plugin-syntax-json-strings": { @@ -430,9 +410,6 @@ "dev": true, "dependencies": { "@babel/helper-plugin-utils": "^7.8.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" } }, "node_modules/@babel/plugin-syntax-logical-assignment-operators": { @@ -442,9 +419,6 @@ "dev": true, "dependencies": { "@babel/helper-plugin-utils": "^7.10.4" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" } }, "node_modules/@babel/plugin-syntax-nullish-coalescing-operator": { @@ -454,9 +428,6 @@ "dev": true, "dependencies": { "@babel/helper-plugin-utils": "^7.8.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" } }, "node_modules/@babel/plugin-syntax-numeric-separator": { @@ -466,9 +437,6 @@ "dev": true, "dependencies": { "@babel/helper-plugin-utils": "^7.10.4" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" } }, "node_modules/@babel/plugin-syntax-object-rest-spread": { @@ -478,9 +446,6 @@ "dev": true, "dependencies": { "@babel/helper-plugin-utils": "^7.8.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" } }, "node_modules/@babel/plugin-syntax-optional-catch-binding": { @@ -490,9 +455,6 @@ "dev": true, "dependencies": { "@babel/helper-plugin-utils": "^7.8.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" } }, "node_modules/@babel/plugin-syntax-optional-chaining": { @@ -502,9 +464,6 @@ "dev": true, "dependencies": { "@babel/helper-plugin-utils": "^7.8.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" } }, "node_modules/@babel/plugin-syntax-top-level-await": { @@ -517,9 +476,6 @@ }, "engines": { "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" } }, "node_modules/@babel/plugin-syntax-typescript": { @@ -532,9 +488,6 @@ }, "engines": { "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" } }, "node_modules/@babel/template": { @@ -670,14 +623,6 @@ }, "engines": { "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" - }, - "peerDependencies": { - "node-notifier": "^8.0.1 || ^9.0.0 || ^10.0.0" - }, - "peerDependenciesMeta": { - "node-notifier": { - "optional": true - } } }, "node_modules/@jest/environment": { @@ -760,14 +705,6 @@ }, "engines": { "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" - }, - "peerDependencies": { - "node-notifier": "^8.0.1 || ^9.0.0 || ^10.0.0" - }, - "peerDependenciesMeta": { - "node-notifier": { - "optional": true - } } }, "node_modules/@jest/source-map": { @@ -884,10 +821,7 @@ "node_modules/@node-redis/bloom": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/@node-redis/bloom/-/bloom-1.0.1.tgz", - "integrity": "sha512-mXEBvEIgF4tUzdIN89LiYsbi6//EdpFA7L8M+DHCvePXg+bfHWi+ct5VI6nHUFQE5+ohm/9wmgihCH3HSkeKsw==", - "peerDependencies": { - "@node-redis/client": "^1.0.0" - } + "integrity": "sha512-mXEBvEIgF4tUzdIN89LiYsbi6//EdpFA7L8M+DHCvePXg+bfHWi+ct5VI6nHUFQE5+ohm/9wmgihCH3HSkeKsw==" }, "node_modules/@node-redis/client": { "version": "1.0.4", @@ -906,34 +840,22 @@ "node_modules/@node-redis/graph": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/@node-redis/graph/-/graph-1.0.0.tgz", - "integrity": "sha512-mRSo8jEGC0cf+Rm7q8mWMKKKqkn6EAnA9IA2S3JvUv/gaWW/73vil7GLNwion2ihTptAm05I9LkepzfIXUKX5g==", - "peerDependencies": { - "@node-redis/client": "^1.0.0" - } + "integrity": "sha512-mRSo8jEGC0cf+Rm7q8mWMKKKqkn6EAnA9IA2S3JvUv/gaWW/73vil7GLNwion2ihTptAm05I9LkepzfIXUKX5g==" }, "node_modules/@node-redis/json": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/@node-redis/json/-/json-1.0.2.tgz", - "integrity": "sha512-qVRgn8WfG46QQ08CghSbY4VhHFgaTY71WjpwRBGEuqGPfWwfRcIf3OqSpR7Q/45X+v3xd8mvYjywqh0wqJ8T+g==", - "peerDependencies": { - "@node-redis/client": "^1.0.0" - } + "integrity": "sha512-qVRgn8WfG46QQ08CghSbY4VhHFgaTY71WjpwRBGEuqGPfWwfRcIf3OqSpR7Q/45X+v3xd8mvYjywqh0wqJ8T+g==" }, "node_modules/@node-redis/search": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/@node-redis/search/-/search-1.0.3.tgz", - "integrity": "sha512-rsrzkGWI84di/uYtEctS/4qLusWt0DESx/psjfB0TFpORDhe7JfC0h8ary+eHulTksumor244bXLRSqQXbFJmw==", - "peerDependencies": { - "@node-redis/client": "^1.0.0" - } + "integrity": "sha512-rsrzkGWI84di/uYtEctS/4qLusWt0DESx/psjfB0TFpORDhe7JfC0h8ary+eHulTksumor244bXLRSqQXbFJmw==" }, "node_modules/@node-redis/time-series": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/@node-redis/time-series/-/time-series-1.0.2.tgz", - "integrity": "sha512-HGQ8YooJ8Mx7l28tD7XjtB3ImLEjlUxG1wC1PAjxu6hPJqjPshUZxAICzDqDjtIbhDTf48WXXUcx8TQJB1XTKA==", - "peerDependencies": { - "@node-redis/client": "^1.0.0" - } + "integrity": "sha512-HGQ8YooJ8Mx7l28tD7XjtB3ImLEjlUxG1wC1PAjxu6hPJqjPshUZxAICzDqDjtIbhDTf48WXXUcx8TQJB1XTKA==" }, "node_modules/@sindresorhus/is": { "version": "0.14.0", @@ -1192,9 +1114,6 @@ }, "engines": { "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/ansi-regex": { @@ -1216,9 +1135,6 @@ }, "engines": { "node": ">=8" - }, - "funding": { - "url": "https://github.com/chalk/ansi-styles?sponsor=1" } }, "node_modules/anymatch": { @@ -1266,9 +1182,6 @@ }, "engines": { "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" - }, - "peerDependencies": { - "@babel/core": "^7.8.0" } }, "node_modules/babel-plugin-istanbul": { @@ -1320,9 +1233,6 @@ "@babel/plugin-syntax-optional-catch-binding": "^7.8.3", "@babel/plugin-syntax-optional-chaining": "^7.8.3", "@babel/plugin-syntax-top-level-await": "^7.8.3" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" } }, "node_modules/babel-preset-jest": { @@ -1336,9 +1246,6 @@ }, "engines": { "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" } }, "node_modules/balanced-match": { @@ -1373,9 +1280,6 @@ }, "engines": { "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/boxen/node_modules/camelcase": { @@ -1385,9 +1289,6 @@ "dev": true, "engines": { "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/boxen/node_modules/type-fest": { @@ -1397,9 +1298,6 @@ "dev": true, "engines": { "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/brace-expansion": { @@ -1447,10 +1345,6 @@ }, "engines": { "node": "^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/browserslist" } }, "node_modules/bs-logger": { @@ -1508,9 +1402,6 @@ }, "engines": { "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/cacheable-request/node_modules/lowercase-keys": { @@ -1544,11 +1435,7 @@ "version": "1.0.30001312", "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001312.tgz", "integrity": "sha512-Wiz1Psk2MEK0pX3rUzWaunLTZzqS2JYZFzNKqAiJGiuxIjRPLgV6+VDPOg6lQOUxmDwhTlh198JsTTi8Hzw6aQ==", - "dev": true, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/browserslist" - } + "dev": true }, "node_modules/chalk": { "version": "4.1.2", @@ -1561,9 +1448,6 @@ }, "engines": { "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/chalk?sponsor=1" } }, "node_modules/char-regex": { @@ -1580,12 +1464,6 @@ "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.5.3.tgz", "integrity": "sha512-Dr3sfKRP6oTcjf2JmUmFJfeVMvXBdegxB0iVQ5eb2V10uFJUCAS8OByZdVAyVb8xXNz3GjjTgj9kLWsZTqE6kw==", "dev": true, - "funding": [ - { - "type": "individual", - "url": "https://paulmillr.com/funding/" - } - ], "dependencies": { "anymatch": "~3.1.2", "braces": "~3.0.2", @@ -1621,9 +1499,6 @@ "dev": true, "engines": { "node": ">=6" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/cliui": { @@ -1803,11 +1678,6 @@ }, "engines": { "node": ">=6.0" - }, - "peerDependenciesMeta": { - "supports-color": { - "optional": true - } } }, "node_modules/decimal.js": { @@ -1943,9 +1813,6 @@ "dev": true, "engines": { "node": ">=10" - }, - "funding": { - "url": "https://github.com/sindresorhus/emittery?sponsor=1" } }, "node_modules/emoji-regex": { @@ -2008,7 +1875,8 @@ "esprima": "^4.0.1", "estraverse": "^5.2.0", "esutils": "^2.0.2", - "optionator": "^0.8.1" + "optionator": "^0.8.1", + "source-map": "~0.6.1" }, "bin": { "escodegen": "bin/escodegen.js", @@ -2016,9 +1884,6 @@ }, "engines": { "node": ">=6.0" - }, - "optionalDependencies": { - "source-map": "~0.6.1" } }, "node_modules/esprima": { @@ -2070,9 +1935,6 @@ }, "engines": { "node": ">=10" - }, - "funding": { - "url": "https://github.com/sindresorhus/execa?sponsor=1" } }, "node_modules/exit": { @@ -2170,7 +2032,6 @@ "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.2.tgz", "integrity": "sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==", "dev": true, - "hasInstallScript": true, "optional": true, "os": [ "darwin" @@ -2227,9 +2088,6 @@ "dev": true, "engines": { "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/glob": { @@ -2247,9 +2105,6 @@ }, "engines": { "node": "*" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" } }, "node_modules/glob-parent": { @@ -2274,9 +2129,6 @@ }, "engines": { "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/globals": { @@ -2480,9 +2332,6 @@ }, "engines": { "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/imurmurhash": { @@ -2562,9 +2411,6 @@ "dev": true, "dependencies": { "has": "^1.0.3" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" } }, "node_modules/is-extglob": { @@ -2617,9 +2463,6 @@ }, "engines": { "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/is-npm": { @@ -2629,9 +2472,6 @@ "dev": true, "engines": { "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/is-number": { @@ -2674,9 +2514,6 @@ "dev": true, "engines": { "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/is-typedarray": { @@ -2778,14 +2615,6 @@ }, "engines": { "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" - }, - "peerDependencies": { - "node-notifier": "^8.0.1 || ^9.0.0 || ^10.0.0" - }, - "peerDependenciesMeta": { - "node-notifier": { - "optional": true - } } }, "node_modules/jest-changed-files": { @@ -2856,14 +2685,6 @@ }, "engines": { "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" - }, - "peerDependencies": { - "node-notifier": "^8.0.1 || ^9.0.0 || ^10.0.0" - }, - "peerDependenciesMeta": { - "node-notifier": { - "optional": true - } } }, "node_modules/jest-config": { @@ -2899,14 +2720,6 @@ }, "engines": { "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" - }, - "peerDependencies": { - "ts-node": ">=9.0.0" - }, - "peerDependenciesMeta": { - "ts-node": { - "optional": true - } } }, "node_modules/jest-diff": { @@ -3118,14 +2931,6 @@ "dev": true, "engines": { "node": ">=6" - }, - "peerDependencies": { - "jest-resolve": "*" - }, - "peerDependenciesMeta": { - "jest-resolve": { - "optional": true - } } }, "node_modules/jest-regex-util": { @@ -3339,9 +3144,6 @@ "dev": true, "engines": { "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/jest-watcher": { @@ -3386,9 +3188,6 @@ }, "engines": { "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/supports-color?sponsor=1" } }, "node_modules/js-tokens": { @@ -3446,14 +3245,6 @@ }, "engines": { "node": ">=10" - }, - "peerDependencies": { - "canvas": "^2.5.0" - }, - "peerDependenciesMeta": { - "canvas": { - "optional": true - } } }, "node_modules/jsesc": { @@ -3620,9 +3411,6 @@ }, "engines": { "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/make-error": { @@ -3763,7 +3551,6 @@ "resolved": "https://registry.npmjs.org/nodemon/-/nodemon-2.0.15.tgz", "integrity": "sha512-gdHMNx47Gw7b3kWxJV64NI+Q5nfl0y5DgDbiVtShiwa7Z0IZ07Ll4RLFo6AjrhzMtoEZn5PDE3/c2AbVsiCkpA==", "dev": true, - "hasInstallScript": true, "dependencies": { "chokidar": "^3.5.2", "debug": "^3.2.7", @@ -3781,10 +3568,6 @@ }, "engines": { "node": ">=8.10.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/nodemon" } }, "node_modules/nodemon/node_modules/debug": { @@ -3836,9 +3619,6 @@ }, "bin": { "nopt": "bin/nopt.js" - }, - "engines": { - "node": "*" } }, "node_modules/normalize-path": { @@ -3896,9 +3676,6 @@ }, "engines": { "node": ">=6" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/optionator": { @@ -3937,9 +3714,6 @@ }, "engines": { "node": ">=6" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/p-locate": { @@ -3991,9 +3765,6 @@ }, "engines": { "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/parse5": { @@ -4048,9 +3819,6 @@ "dev": true, "engines": { "node": ">=8.6" - }, - "funding": { - "url": "https://github.com/sponsors/jonschlinkert" } }, "node_modules/pirates": { @@ -4113,9 +3881,6 @@ "dev": true, "engines": { "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/ansi-styles?sponsor=1" } }, "node_modules/prompts": { @@ -4299,9 +4064,6 @@ }, "bin": { "resolve": "bin/resolve" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" } }, "node_modules/resolve-cwd": { @@ -4353,9 +4115,6 @@ }, "bin": { "rimraf": "bin.js" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" } }, "node_modules/safe-buffer": { @@ -4557,9 +4316,6 @@ "dev": true, "engines": { "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/supports-color": { @@ -4594,9 +4350,6 @@ "dev": true, "engines": { "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" } }, "node_modules/symbol-tree": { @@ -4616,9 +4369,6 @@ }, "engines": { "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/test-exclude": { @@ -4735,28 +4485,6 @@ }, "engines": { "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" - }, - "peerDependencies": { - "@babel/core": ">=7.0.0-beta.0 <8", - "@types/jest": "^27.0.0", - "babel-jest": ">=27.0.0 <28", - "esbuild": "~0.14.0", - "jest": "^27.0.0", - "typescript": ">=3.8 <5.0" - }, - "peerDependenciesMeta": { - "@babel/core": { - "optional": true - }, - "@types/jest": { - "optional": true - }, - "babel-jest": { - "optional": true - }, - "esbuild": { - "optional": true - } } }, "node_modules/ts-jest/node_modules/semver": { @@ -4808,9 +4536,6 @@ "dev": true, "engines": { "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/typedarray-to-buffer": { @@ -4839,9 +4564,6 @@ }, "engines": { "node": ">= 12.10.0" - }, - "peerDependencies": { - "typescript": "4.0.x || 4.1.x || 4.2.x || 4.3.x || 4.4.x || 4.5.x" } }, "node_modules/typedoc-plugin-markdown": { @@ -4851,9 +4573,6 @@ "dev": true, "dependencies": { "handlebars": "^4.7.7" - }, - "peerDependencies": { - "typedoc": ">=0.22.0" } }, "node_modules/typescript": { @@ -4940,9 +4659,6 @@ }, "engines": { "node": ">=10" - }, - "funding": { - "url": "https://github.com/yeoman/update-notifier?sponsor=1" } }, "node_modules/update-notifier/node_modules/semver": { @@ -5129,9 +4845,6 @@ }, "engines": { "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/wrap-ansi?sponsor=1" } }, "node_modules/wrappy": { @@ -5159,18 +4872,6 @@ "dev": true, "engines": { "node": ">=8.3.0" - }, - "peerDependencies": { - "bufferutil": "^4.0.1", - "utf-8-validate": "^5.0.2" - }, - "peerDependenciesMeta": { - "bufferutil": { - "optional": true - }, - "utf-8-validate": { - "optional": true - } } }, "node_modules/xdg-basedir": { @@ -5897,8 +5598,7 @@ "@node-redis/bloom": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/@node-redis/bloom/-/bloom-1.0.1.tgz", - "integrity": "sha512-mXEBvEIgF4tUzdIN89LiYsbi6//EdpFA7L8M+DHCvePXg+bfHWi+ct5VI6nHUFQE5+ohm/9wmgihCH3HSkeKsw==", - "requires": {} + "integrity": "sha512-mXEBvEIgF4tUzdIN89LiYsbi6//EdpFA7L8M+DHCvePXg+bfHWi+ct5VI6nHUFQE5+ohm/9wmgihCH3HSkeKsw==" }, "@node-redis/client": { "version": "1.0.4", @@ -5914,26 +5614,22 @@ "@node-redis/graph": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/@node-redis/graph/-/graph-1.0.0.tgz", - "integrity": "sha512-mRSo8jEGC0cf+Rm7q8mWMKKKqkn6EAnA9IA2S3JvUv/gaWW/73vil7GLNwion2ihTptAm05I9LkepzfIXUKX5g==", - "requires": {} + "integrity": "sha512-mRSo8jEGC0cf+Rm7q8mWMKKKqkn6EAnA9IA2S3JvUv/gaWW/73vil7GLNwion2ihTptAm05I9LkepzfIXUKX5g==" }, "@node-redis/json": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/@node-redis/json/-/json-1.0.2.tgz", - "integrity": "sha512-qVRgn8WfG46QQ08CghSbY4VhHFgaTY71WjpwRBGEuqGPfWwfRcIf3OqSpR7Q/45X+v3xd8mvYjywqh0wqJ8T+g==", - "requires": {} + "integrity": "sha512-qVRgn8WfG46QQ08CghSbY4VhHFgaTY71WjpwRBGEuqGPfWwfRcIf3OqSpR7Q/45X+v3xd8mvYjywqh0wqJ8T+g==" }, "@node-redis/search": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/@node-redis/search/-/search-1.0.3.tgz", - "integrity": "sha512-rsrzkGWI84di/uYtEctS/4qLusWt0DESx/psjfB0TFpORDhe7JfC0h8ary+eHulTksumor244bXLRSqQXbFJmw==", - "requires": {} + "integrity": "sha512-rsrzkGWI84di/uYtEctS/4qLusWt0DESx/psjfB0TFpORDhe7JfC0h8ary+eHulTksumor244bXLRSqQXbFJmw==" }, "@node-redis/time-series": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/@node-redis/time-series/-/time-series-1.0.2.tgz", - "integrity": "sha512-HGQ8YooJ8Mx7l28tD7XjtB3ImLEjlUxG1wC1PAjxu6hPJqjPshUZxAICzDqDjtIbhDTf48WXXUcx8TQJB1XTKA==", - "requires": {} + "integrity": "sha512-HGQ8YooJ8Mx7l28tD7XjtB3ImLEjlUxG1wC1PAjxu6hPJqjPshUZxAICzDqDjtIbhDTf48WXXUcx8TQJB1XTKA==" }, "@sindresorhus/is": { "version": "0.14.0", @@ -7612,8 +7308,7 @@ "version": "1.2.2", "resolved": "https://registry.npmjs.org/jest-pnp-resolver/-/jest-pnp-resolver-1.2.2.tgz", "integrity": "sha512-olV41bKSMm8BdnuMsewT4jqlZ8+3TCARAXjZGT9jcoSnrfUnRCqnMoF9XEeoWjbzObpqF9dRhHQj0Xb9QdF6/w==", - "dev": true, - "requires": {} + "dev": true }, "jest-regex-util": { "version": "27.5.1", @@ -9163,8 +8858,7 @@ "version": "7.5.7", "resolved": "https://registry.npmjs.org/ws/-/ws-7.5.7.tgz", "integrity": "sha512-KMvVuFzpKBuiIXW3E4u3mySRO2/mCHSyZDJQM5NQ9Q9KHWHWh0NHgfbRMLLrceUK5qAL4ytALJbpRMjixFZh8A==", - "dev": true, - "requires": {} + "dev": true }, "xdg-basedir": { "version": "4.0.0", diff --git a/package.json b/package.json index eb5cc8bf..13455b3e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "redis-om", - "version": "0.2.1", + "version": "0.3.0", "description": "Object mapping, and more, for Redis and Node.js. Written in TypeScript.", "main": "dist/index.js", "types": "./dist/index.d.ts", @@ -46,4 +46,4 @@ "redis": "^4.0.4", "ulid": "^2.3.0" } -} \ No newline at end of file +} diff --git a/spec/functional/search/create-and-drop-index-on-hash.spec.ts b/spec/functional/search/create-and-drop-index-on-hash.spec.ts index c8fab235..2884b5ed 100644 --- a/spec/functional/search/create-and-drop-index-on-hash.spec.ts +++ b/spec/functional/search/create-and-drop-index-on-hash.spec.ts @@ -47,7 +47,7 @@ describe("create and drop index on hash", () => { }); it("has the expected hash", () => { - expect(indexHash).toBe("UInOmUVXfuDjIlUOc5+iZWTmTus="); + expect(indexHash).toBe("dTSTRvH6wlaP2RtA8qQBjA5GbKw="); }); it("has the expected fields", () => { @@ -101,7 +101,7 @@ describe("create and drop index on hash", () => { expect(indexName).toBe('SampleHashEntity:index'); expect(keyType).toBe('HASH'); expect(prefixes).toEqual(['SampleHashEntity:']); - expect(indexHash).toBe("UInOmUVXfuDjIlUOc5+iZWTmTus="); + expect(indexHash).toBe("dTSTRvH6wlaP2RtA8qQBjA5GbKw="); expect(fields).toHaveLength(14); expect(fields).toEqual([ @@ -141,7 +141,7 @@ describe("create and drop index on hash", () => { expect(indexName).toBe('sample-hash-entity:index'); expect(keyType).toBe('HASH'); expect(prefixes).toEqual(['sample-hash-entity:']); - expect(indexHash).toBe("SArdgZ1xX70Tn02anKnE6vx/fAk="); + expect(indexHash).toBe("HLLDgFiBuLGErZ1sUSjk/o/et54="); }); }); }); diff --git a/spec/functional/search/create-and-drop-index-on-json.spec.ts b/spec/functional/search/create-and-drop-index-on-json.spec.ts index 262fae7b..24b596e9 100644 --- a/spec/functional/search/create-and-drop-index-on-json.spec.ts +++ b/spec/functional/search/create-and-drop-index-on-json.spec.ts @@ -47,7 +47,7 @@ describe("create and drop index on JSON", () => { }); it("has the expected hash", () => { - expect(indexHash).toBe("XgD0DXohHu8y4/JvvbEWhZCoiWk="); + expect(indexHash).toBe("CG+oldxDhlhKcav02fnypVl5+jI="); }); it("has the expected fields", () => { @@ -101,7 +101,7 @@ describe("create and drop index on JSON", () => { expect(indexName).toBe('SampleJsonEntity:index'); expect(keyType).toBe('JSON'); expect(prefixes).toEqual(['SampleJsonEntity:']); - expect(indexHash).toBe("XgD0DXohHu8y4/JvvbEWhZCoiWk="); + expect(indexHash).toBe("CG+oldxDhlhKcav02fnypVl5+jI="); expect(fields).toHaveLength(14); expect(fields).toEqual([ @@ -141,7 +141,7 @@ describe("create and drop index on JSON", () => { expect(indexName).toBe('sample-json-entity:index'); expect(keyType).toBe('JSON'); expect(prefixes).toEqual(['sample-json-entity:']); - expect(indexHash).toBe("Tm5jE5zHI3uyJd4HFJiMwPBPquo="); + expect(indexHash).toBe("1H4rkUnjh4UyVJlI5Z6JCCTD1Zg="); }); }); });