Generated docs

redis · Jun 8, 2022 · a668298 · a668298
1 parent c811df6
commit a668298
Show file tree

Hide file tree

Showing 27 changed files with 694 additions and 205 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -22,16 +22,21 @@ redis-om
 
 - [BaseFieldDefinition](interfaces/BaseFieldDefinition.md)
 - [BooleanFieldDefinition](interfaces/BooleanFieldDefinition.md)
+- [CaseSensitiveFieldDefinition](interfaces/CaseSensitiveFieldDefinition.md)
 - [DateFieldDefinition](interfaces/DateFieldDefinition.md)
+- [NormalizedFieldDefinition](interfaces/NormalizedFieldDefinition.md)
 - [NumberFieldDefinition](interfaces/NumberFieldDefinition.md)
+- [PhoneticFieldDefinition](interfaces/PhoneticFieldDefinition.md)
 - [PointFieldDefinition](interfaces/PointFieldDefinition.md)
 - [SeparableFieldDefinition](interfaces/SeparableFieldDefinition.md)
 - [SortableFieldDefinition](interfaces/SortableFieldDefinition.md)
+- [StemmingFieldDefinition](interfaces/StemmingFieldDefinition.md)
 - [StringArrayFieldDefinition](interfaces/StringArrayFieldDefinition.md)
 - [StringFieldDefinition](interfaces/StringFieldDefinition.md)
 - [TextFieldDefinition](interfaces/TextFieldDefinition.md)
+- [WeightFieldDefinition](interfaces/WeightFieldDefinition.md)
 
-### Type Aliases
+### Type aliases
 
 - [CircleFunction](README.md#circlefunction)
 - [DataStructure](README.md#datastructure)
@@ -48,7 +53,7 @@ redis-om
 - [StopWordOptions](README.md#stopwordoptions)
 - [SubSearchFunction](README.md#subsearchfunction)
 
-## Type Aliases
+## Type aliases
 
 ### CircleFunction
 
@@ -72,7 +77,7 @@ A function that defines a circle for `.inCircle` searches.
 
 #### Defined in
 
-[lib/search/where-point.ts:9](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/where-point.ts#L9)
+[lib/search/where-point.ts:9](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/where-point.ts#L9)
 
 ___
 
@@ -84,7 +89,7 @@ The type of data structure in Redis to map objects to.
 
 #### Defined in
 
-[lib/schema/options/data-structure.ts:2](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/options/data-structure.ts#L2)
+[lib/schema/options/data-structure.ts:2](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/options/data-structure.ts#L2)
 
 ___
 
@@ -114,7 +119,7 @@ A constructor that creates an [Entity](classes/Entity.md) of type TEntity.
 
 #### Defined in
 
-[lib/entity/entity-constructor.ts:8](https://github.com/redis/redis-om-node/blob/9268f6d/lib/entity/entity-constructor.ts#L8)
+[lib/entity/entity-constructor.ts:8](https://github.com/redis/redis-om-node/blob/48d362b/lib/entity/entity-constructor.ts#L8)
 
 ___
 
@@ -126,7 +131,7 @@ A JavaScript object containing the underlying data of an [Entity](classes/Entity
 
 #### Defined in
 
-[lib/entity/entity-data.ts:6](https://github.com/redis/redis-om-node/blob/9268f6d/lib/entity/entity-data.ts#L6)
+[lib/entity/entity-data.ts:6](https://github.com/redis/redis-om-node/blob/48d362b/lib/entity/entity-data.ts#L6)
 
 ___
 
@@ -138,7 +143,7 @@ Valid types for properties on an [Entity](classes/Entity.md).
 
 #### Defined in
 
-[lib/entity/entity-value.ts:6](https://github.com/redis/redis-om-node/blob/9268f6d/lib/entity/entity-value.ts#L6)
+[lib/entity/entity-value.ts:6](https://github.com/redis/redis-om-node/blob/48d362b/lib/entity/entity-value.ts#L6)
 
 ___
 
@@ -150,7 +155,7 @@ Contains instructions telling how to map a property on an [Entity](classes/Entit
 
 #### Defined in
 
-[lib/schema/definition/field-definition.ts:10](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/field-definition.ts#L10)
+[lib/schema/definition/field-definition.ts:10](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/field-definition.ts#L10)
 
 ___
 
@@ -170,7 +175,7 @@ A function that generates random [Entity IDs](classes/Entity.md#entityid).
 
 #### Defined in
 
-[lib/schema/options/id-strategy.ts:2](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/options/id-strategy.ts#L2)
+[lib/schema/options/id-strategy.ts:2](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/options/id-strategy.ts#L2)
 
 ___
 
@@ -189,7 +194,7 @@ Defines a point on the globe using longitude and latitude.
 
 #### Defined in
 
-[lib/entity/point.ts:2](https://github.com/redis/redis-om-node/blob/9268f6d/lib/entity/point.ts#L2)
+[lib/entity/point.ts:2](https://github.com/redis/redis-om-node/blob/48d362b/lib/entity/point.ts#L2)
 
 ___
 
@@ -201,7 +206,7 @@ Group of [FieldDefinition](README.md#fielddefinition)s that define the schema fo
 
 #### Defined in
 
-[lib/schema/definition/schema-definition.ts:6](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/schema-definition.ts#L6)
+[lib/schema/definition/schema-definition.ts:6](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/schema-definition.ts#L6)
 
 ___
 
@@ -213,7 +218,7 @@ Valid types a [FieldDefinition](README.md#fielddefinition).
 
 #### Defined in
 
-[lib/schema/definition/schema-field-type.ts:4](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/definition/schema-field-type.ts#L4)
+[lib/schema/definition/schema-field-type.ts:4](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/definition/schema-field-type.ts#L4)
 
 ___
 
@@ -231,13 +236,14 @@ Configuration options for a [Schema](classes/Schema.md).
 | `idStrategy?` | [`IdStrategy`](README.md#idstrategy) | A function that generates a random [Entity ID](classes/Entity.md#entityid). Defaults to a function that generates [ULIDs](https://github.com/ulid/spec). Combined with prefix to generate a Redis key. If prefix is `Foo` and idStratgey returns `12345` then the generated key would be `Foo:12345`. |
 | `indexHashName?` | `string` | The name used by Redis OM to store the hash of the index for this [Schema](classes/Schema.md). Defaults to prefix followed by `:index:hash`. So, for a prefix of `Foo`, it would use `Foo:index:hash`. |
 | `indexName?` | `string` | The name used by RediSearch to store the index for this [Schema](classes/Schema.md). Defaults to prefix followed by `:index`. So, for a prefix of `Foo`, it would use `Foo:index`. |
+| `indexedDefault?` | `boolean` | Whether fields are indexed by default |
 | `prefix?` | `string` | The string that comes before the ID when creating Redis keys for [Entities](classes/Entity.md). Defaults to the class name of the [Entity](classes/Entity.md). Combined with the results of idStrategy to generate a key. If prefix is `Foo` and idStrategy returns `12345` then the generated key would be `Foo:12345`. |
 | `stopWords?` | `string`[] | Stop words to be used by this schema. If `useStopWords` is anything other than `CUSTOM`, this option is ignored. |
 | `useStopWords?` | [`StopWordOptions`](README.md#stopwordoptions) | Configures the usage of stop words. Valid values are `OFF`, `DEFAULT`, and `CUSTOM`. Setting this to `OFF` disables all stop words. Setting this to `DEFAULT` uses the stop words intrinsic to RediSearch. Setting this to `CUSTOM` tells RediSearch to use the stop words in `stopWords`. |
 
 #### Defined in
 
-[lib/schema/options/schema-options.ts:9](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/options/schema-options.ts#L9)
+[lib/schema/options/schema-options.ts:9](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/options/schema-options.ts#L9)
 
 ___
 
@@ -249,7 +255,7 @@ The type of data structure in Redis to map objects to.
 
 #### Defined in
 
-[lib/client.ts:21](https://github.com/redis/redis-om-node/blob/9268f6d/lib/client.ts#L21)
+[lib/client.ts:21](https://github.com/redis/redis-om-node/blob/48d362b/lib/client.ts#L21)
 
 ___
 
@@ -261,7 +267,7 @@ Valid values for how to use stop words for a given [Schema](classes/Schema.md).
 
 #### Defined in
 
-[lib/schema/options/stop-word-options.ts:2](https://github.com/redis/redis-om-node/blob/9268f6d/lib/schema/options/stop-word-options.ts#L2)
+[lib/schema/options/stop-word-options.ts:2](https://github.com/redis/redis-om-node/blob/48d362b/lib/schema/options/stop-word-options.ts#L2)
 
 ___
 
@@ -293,4 +299,4 @@ A function that takes a [Search](classes/Search.md) and returns a [Search](class
 
 #### Defined in
 
-[lib/search/search.ts:27](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L27)
+[lib/search/search.ts:27](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L27)
diff --git a/docs/classes/AbstractSearch.md b/docs/classes/AbstractSearch.md
@@ -61,7 +61,7 @@ this
 
 #### Defined in
 
-[lib/search/search.ts:210](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L210)
+[lib/search/search.ts:210](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L210)
 
 ## Methods
 
@@ -93,7 +93,7 @@ An array of [Entities](Entity.md) matching the query.
 
 #### Defined in
 
-[lib/search/search.ts:191](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L191)
+[lib/search/search.ts:191](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L191)
 
 ___
 
@@ -109,7 +109,7 @@ Returns the number of [Entities](Entity.md) that match this query.
 
 #### Defined in
 
-[lib/search/search.ts:149](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L149)
+[lib/search/search.ts:149](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L149)
 
 ___
 
@@ -125,7 +125,7 @@ Returns only the first [Entity](Entity.md) that matches this query.
 
 #### Defined in
 
-[lib/search/search.ts:172](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L172)
+[lib/search/search.ts:172](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L172)
 
 ___
 
@@ -149,7 +149,7 @@ The [Entity](Entity.md) with the maximal value
 
 #### Defined in
 
-[lib/search/search.ts:141](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L141)
+[lib/search/search.ts:141](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L141)
 
 ___
 
@@ -173,7 +173,7 @@ The [Entity](Entity.md) with the minimal value
 
 #### Defined in
 
-[lib/search/search.ts:132](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L132)
+[lib/search/search.ts:132](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L132)
 
 ___
 
@@ -198,7 +198,7 @@ An array of [Entities](Entity.md) matching the query.
 
 #### Defined in
 
-[lib/search/search.ts:162](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L162)
+[lib/search/search.ts:162](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L162)
 
 ___
 
@@ -221,7 +221,7 @@ Alias for [Search.all](Search.md#all).
 
 #### Defined in
 
-[lib/search/search.ts:245](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L245)
+[lib/search/search.ts:245](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L245)
 
 ___
 
@@ -237,7 +237,7 @@ Alias for [Search.count](Search.md#count).
 
 #### Defined in
 
-[lib/search/search.ts:231](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L231)
+[lib/search/search.ts:231](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L231)
 
 ___
 
@@ -253,7 +253,7 @@ Alias for [Search.first](Search.md#first).
 
 #### Defined in
 
-[lib/search/search.ts:252](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L252)
+[lib/search/search.ts:252](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L252)
 
 ___
 
@@ -275,7 +275,7 @@ Alias for [Search.max](Search.md#max).
 
 #### Defined in
 
-[lib/search/search.ts:224](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L224)
+[lib/search/search.ts:224](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L224)
 
 ___
 
@@ -297,7 +297,7 @@ Alias for [Search.min](Search.md#min).
 
 #### Defined in
 
-[lib/search/search.ts:217](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L217)
+[lib/search/search.ts:217](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L217)
 
 ___
 
@@ -320,7 +320,7 @@ Alias for [Search.page](Search.md#page).
 
 #### Defined in
 
-[lib/search/search.ts:238](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L238)
+[lib/search/search.ts:238](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L238)
 
 ___
 
@@ -342,7 +342,7 @@ Alias for [Search.sortAscending](Search.md#sortascending).
 
 #### Defined in
 
-[lib/search/search.ts:84](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L84)
+[lib/search/search.ts:84](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L84)
 
 ___
 
@@ -366,7 +366,7 @@ this
 
 #### Defined in
 
-[lib/search/search.ts:61](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L61)
+[lib/search/search.ts:61](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L61)
 
 ___
 
@@ -391,7 +391,7 @@ this
 
 #### Defined in
 
-[lib/search/search.ts:94](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L94)
+[lib/search/search.ts:94](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L94)
 
 ___
 
@@ -413,7 +413,7 @@ Alias for [Search.sortDescending](Search.md#sortdescending).
 
 #### Defined in
 
-[lib/search/search.ts:68](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L68)
+[lib/search/search.ts:68](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L68)
 
 ___
 
@@ -437,4 +437,4 @@ this
 
 #### Defined in
 
-[lib/search/search.ts:77](https://github.com/redis/redis-om-node/blob/9268f6d/lib/search/search.ts#L77)
+[lib/search/search.ts:77](https://github.com/redis/redis-om-node/blob/48d362b/lib/search/search.ts#L77)