Skip to content

Commit

Permalink
regenerated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@guyroyse
guyroyse committed Jul 11, 2022
1 parent 47d4d36 commit 96010ff
Show file tree
Hide file tree
Showing 27 changed files with 341 additions and 286 deletions.
28 changes: 14 additions & 14 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ A function that defines a circle for `.inCircle` searches.

#### Defined in

[lib/search/where-point.ts:9](https://github.com/redis/redis-om-node/blob/000c57c/lib/search/where-point.ts#L9)
[lib/search/where-point.ts:9](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/where-point.ts#L9)

___

Expand All @@ -89,7 +89,7 @@ The type of data structure in Redis to map objects to.

#### Defined in

[lib/schema/options/data-structure.ts:2](https://github.com/redis/redis-om-node/blob/000c57c/lib/schema/options/data-structure.ts#L2)
[lib/schema/options/data-structure.ts:2](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/options/data-structure.ts#L2)

___

Expand Down Expand Up @@ -119,7 +119,7 @@ A constructor that creates an [Entity](classes/Entity.md) of type TEntity.

#### Defined in

[lib/entity/entity-constructor.ts:8](https://github.com/redis/redis-om-node/blob/000c57c/lib/entity/entity-constructor.ts#L8)
[lib/entity/entity-constructor.ts:8](https://github.com/redis/redis-om-node/blob/47d4d36/lib/entity/entity-constructor.ts#L8)

___

Expand All @@ -131,7 +131,7 @@ A JavaScript object containing the underlying data of an [Entity](classes/Entity

#### Defined in

[lib/entity/entity-data.ts:6](https://github.com/redis/redis-om-node/blob/000c57c/lib/entity/entity-data.ts#L6)
[lib/entity/entity-data.ts:6](https://github.com/redis/redis-om-node/blob/47d4d36/lib/entity/entity-data.ts#L6)

___

Expand All @@ -143,7 +143,7 @@ Valid types for properties on an [Entity](classes/Entity.md).

#### Defined in

[lib/entity/entity-value.ts:6](https://github.com/redis/redis-om-node/blob/000c57c/lib/entity/entity-value.ts#L6)
[lib/entity/entity-value.ts:6](https://github.com/redis/redis-om-node/blob/47d4d36/lib/entity/entity-value.ts#L6)

___

Expand All @@ -155,7 +155,7 @@ Contains instructions telling how to map a property on an [Entity](classes/Entit

#### Defined in

[lib/schema/definition/field-definition.ts:10](https://github.com/redis/redis-om-node/blob/000c57c/lib/schema/definition/field-definition.ts#L10)
[lib/schema/definition/field-definition.ts:10](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/definition/field-definition.ts#L10)

___

Expand All @@ -175,7 +175,7 @@ A function that generates random [Entity IDs](classes/Entity.md#entityid).

#### Defined in

[lib/schema/options/id-strategy.ts:2](https://github.com/redis/redis-om-node/blob/000c57c/lib/schema/options/id-strategy.ts#L2)
[lib/schema/options/id-strategy.ts:2](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/options/id-strategy.ts#L2)

___

Expand All @@ -194,7 +194,7 @@ Defines a point on the globe using longitude and latitude.

#### Defined in

[lib/entity/point.ts:2](https://github.com/redis/redis-om-node/blob/000c57c/lib/entity/point.ts#L2)
[lib/entity/point.ts:2](https://github.com/redis/redis-om-node/blob/47d4d36/lib/entity/point.ts#L2)

___

Expand All @@ -206,7 +206,7 @@ Group of [FieldDefinition](README.md#fielddefinition)s that define the schema fo

#### Defined in

[lib/schema/definition/schema-definition.ts:6](https://github.com/redis/redis-om-node/blob/000c57c/lib/schema/definition/schema-definition.ts#L6)
[lib/schema/definition/schema-definition.ts:6](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/definition/schema-definition.ts#L6)

___

Expand All @@ -218,7 +218,7 @@ Valid types a [FieldDefinition](README.md#fielddefinition).

#### Defined in

[lib/schema/definition/schema-field-type.ts:4](https://github.com/redis/redis-om-node/blob/000c57c/lib/schema/definition/schema-field-type.ts#L4)
[lib/schema/definition/schema-field-type.ts:4](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/definition/schema-field-type.ts#L4)

___

Expand All @@ -243,7 +243,7 @@ Configuration options for a [Schema](classes/Schema.md).

#### Defined in

[lib/schema/options/schema-options.ts:9](https://github.com/redis/redis-om-node/blob/000c57c/lib/schema/options/schema-options.ts#L9)
[lib/schema/options/schema-options.ts:9](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/options/schema-options.ts#L9)

___

Expand All @@ -255,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/000c57c/lib/client.ts#L21)
[lib/client.ts:23](https://github.com/redis/redis-om-node/blob/47d4d36/lib/client.ts#L23)

___

Expand All @@ -267,7 +267,7 @@ Valid values for how to use stop words for a given [Schema](classes/Schema.md).

#### Defined in

[lib/schema/options/stop-word-options.ts:2](https://github.com/redis/redis-om-node/blob/000c57c/lib/schema/options/stop-word-options.ts#L2)
[lib/schema/options/stop-word-options.ts:2](https://github.com/redis/redis-om-node/blob/47d4d36/lib/schema/options/stop-word-options.ts#L2)

___

Expand Down Expand Up @@ -299,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/000c57c/lib/search/search.ts#L27)
[lib/search/search.ts:26](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L26)
Loading

0 comments on commit 96010ff

Please sign in to comment.