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 26, 2023
1 parent 000d2f3 commit cf3a3dc
Show file tree
Hide file tree
Showing 21 changed files with 312 additions and 282 deletions.
73 changes: 43 additions & 30 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ redis-om
- [FieldDefinition](README.md#fielddefinition)
- [FieldType](README.md#fieldtype)
- [IdStrategy](README.md#idstrategy)
- [NumberArrayFieldDefinition](README.md#numberarrayfielddefinition)
- [NumberFieldDefinition](README.md#numberfielddefinition)
- [Point](README.md#point)
- [PointFieldDefinition](README.md#pointfielddefinition)
Expand Down Expand Up @@ -93,7 +94,7 @@ All configuration properties that any field might have, regardless of type.

#### Defined in

[lib/schema/definitions.ts:5](https://github.com/redis/redis-om-node/blob/660c639/lib/schema/definitions.ts#L5)
[lib/schema/definitions.ts:5](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/definitions.ts#L5)

___

Expand All @@ -105,7 +106,7 @@ A field representing a boolean.

#### Defined in

[lib/schema/definitions.ts:78](https://github.com/redis/redis-om-node/blob/660c639/lib/schema/definitions.ts#L78)
[lib/schema/definitions.ts:78](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/definitions.ts#L78)

___

Expand All @@ -131,7 +132,7 @@ A function that defines a circle for `.inCircle` searches.

#### Defined in

[lib/search/where-point.ts:8](https://github.com/redis/redis-om-node/blob/660c639/lib/search/where-point.ts#L8)
[lib/search/where-point.ts:8](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/where-point.ts#L8)

___

Expand All @@ -143,7 +144,7 @@ The configuration properties that all fields have in common.

#### Defined in

[lib/schema/definitions.ts:75](https://github.com/redis/redis-om-node/blob/660c639/lib/schema/definitions.ts#L75)
[lib/schema/definitions.ts:75](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/definitions.ts#L75)

___

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

#### Defined in

[lib/schema/options.ts:2](https://github.com/redis/redis-om-node/blob/660c639/lib/schema/options.ts#L2)
[lib/schema/options.ts:2](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/options.ts#L2)

___

Expand All @@ -167,7 +168,7 @@ A field representing a date/time.

#### Defined in

[lib/schema/definitions.ts:83](https://github.com/redis/redis-om-node/blob/660c639/lib/schema/definitions.ts#L83)
[lib/schema/definitions.ts:83](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/definitions.ts#L83)

___

Expand All @@ -179,7 +180,7 @@ Defines the objects returned from calls to [repositories](classes/Repository.md)

#### Defined in

[lib/entity/entity.ts:8](https://github.com/redis/redis-om-node/blob/660c639/lib/entity/entity.ts#L8)
[lib/entity/entity.ts:8](https://github.com/redis/redis-om-node/blob/4f5798b/lib/entity/entity.ts#L8)

___

Expand All @@ -195,43 +196,43 @@ The free-form data associated with an [Entity](README.md#entity).

#### Defined in

[lib/entity/entity.ts:18](https://github.com/redis/redis-om-node/blob/660c639/lib/entity/entity.ts#L18)
[lib/entity/entity.ts:18](https://github.com/redis/redis-om-node/blob/4f5798b/lib/entity/entity.ts#L18)

___

### EntityDataValue

Ƭ **EntityDataValue**: `string` \| `number` \| `boolean` \| `Date` \| [`Point`](README.md#point) \| ``null`` \| `undefined`
Ƭ **EntityDataValue**: `string` \| `number` \| `boolean` \| `Date` \| [`Point`](README.md#point) \| ``null`` \| `undefined` \| ([`EntityDataValue`](README.md#entitydatavalue) \| [`EntityData`](README.md#entitydata))[]

Valid types for values in an [Entity](README.md#entity).

#### Defined in

[lib/entity/entity.ts:23](https://github.com/redis/redis-om-node/blob/660c639/lib/entity/entity.ts#L23)
[lib/entity/entity.ts:23](https://github.com/redis/redis-om-node/blob/4f5798b/lib/entity/entity.ts#L23)

___

### FieldDefinition

Ƭ **FieldDefinition**: [`BooleanFieldDefinition`](README.md#booleanfielddefinition) \| [`DateFieldDefinition`](README.md#datefielddefinition) \| [`NumberFieldDefinition`](README.md#numberfielddefinition) \| [`PointFieldDefinition`](README.md#pointfielddefinition) \| [`StringArrayFieldDefinition`](README.md#stringarrayfielddefinition) \| [`StringFieldDefinition`](README.md#stringfielddefinition) \| [`TextFieldDefinition`](README.md#textfielddefinition)
Ƭ **FieldDefinition**: [`BooleanFieldDefinition`](README.md#booleanfielddefinition) \| [`DateFieldDefinition`](README.md#datefielddefinition) \| [`NumberFieldDefinition`](README.md#numberfielddefinition) \| [`NumberArrayFieldDefinition`](README.md#numberarrayfielddefinition) \| [`PointFieldDefinition`](README.md#pointfielddefinition) \| [`StringFieldDefinition`](README.md#stringfielddefinition) \| [`StringArrayFieldDefinition`](README.md#stringarrayfielddefinition) \| [`TextFieldDefinition`](README.md#textfielddefinition)

Contains instructions telling how to map a property on an [Entity](README.md#entity) to Redis.

#### Defined in

[lib/schema/definitions.ts:112](https://github.com/redis/redis-om-node/blob/660c639/lib/schema/definitions.ts#L112)
[lib/schema/definitions.ts:117](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/definitions.ts#L117)

___

### FieldType

Ƭ **FieldType**: ``"boolean"`` \| ``"date"`` \| ``"number"`` \| ``"point"`` \| ``"string"`` \| ``"string[]"`` \| ``"text"``
Ƭ **FieldType**: ``"boolean"`` \| ``"date"`` \| ``"number"`` \| ``"number[]"`` \| ``"point"`` \| ``"string"`` \| ``"string[]"`` \| ``"text"``

Valid field types for a [FieldDefinition](README.md#fielddefinition).

#### Defined in

[lib/schema/definitions.ts:2](https://github.com/redis/redis-om-node/blob/660c639/lib/schema/definitions.ts#L2)
[lib/schema/definitions.ts:2](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/definitions.ts#L2)

___

Expand All @@ -251,7 +252,19 @@ A function that generates random entityIds.

#### Defined in

[lib/schema/options.ts:5](https://github.com/redis/redis-om-node/blob/660c639/lib/schema/options.ts#L5)
[lib/schema/options.ts:5](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/options.ts#L5)

___

### NumberArrayFieldDefinition

Ƭ **NumberArrayFieldDefinition**: { `type`: ``"number[]"`` } & [`CommonFieldDefinition`](README.md#commonfielddefinition) & `Pick`<[`AllFieldDefinition`](README.md#allfielddefinition), ``"sortable"``\>

A field representing an array of numbers.

#### Defined in

[lib/schema/definitions.ts:93](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/definitions.ts#L93)

___

Expand All @@ -263,7 +276,7 @@ A field representing a number.

#### Defined in

[lib/schema/definitions.ts:88](https://github.com/redis/redis-om-node/blob/660c639/lib/schema/definitions.ts#L88)
[lib/schema/definitions.ts:88](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/definitions.ts#L88)

___

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

#### Defined in

[lib/entity/entity.ts:26](https://github.com/redis/redis-om-node/blob/660c639/lib/entity/entity.ts#L26)
[lib/entity/entity.ts:26](https://github.com/redis/redis-om-node/blob/4f5798b/lib/entity/entity.ts#L26)

___

Expand All @@ -294,7 +307,7 @@ A field representing a point on the globe.

#### Defined in

[lib/schema/definitions.ts:93](https://github.com/redis/redis-om-node/blob/660c639/lib/schema/definitions.ts#L93)
[lib/schema/definitions.ts:98](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/definitions.ts#L98)

___

Expand All @@ -306,7 +319,7 @@ A conventional Redis connection.

#### Defined in

[lib/client/client.ts:8](https://github.com/redis/redis-om-node/blob/660c639/lib/client/client.ts#L8)
[lib/client/client.ts:8](https://github.com/redis/redis-om-node/blob/4f5798b/lib/client/client.ts#L8)

___

Expand All @@ -318,7 +331,7 @@ A clustered Redis connection.

#### Defined in

[lib/client/client.ts:11](https://github.com/redis/redis-om-node/blob/660c639/lib/client/client.ts#L11)
[lib/client/client.ts:11](https://github.com/redis/redis-om-node/blob/4f5798b/lib/client/client.ts#L11)

___

Expand All @@ -330,7 +343,7 @@ A Redis connection, clustered or conventional.

#### Defined in

[lib/client/client.ts:14](https://github.com/redis/redis-om-node/blob/660c639/lib/client/client.ts#L14)
[lib/client/client.ts:14](https://github.com/redis/redis-om-node/blob/4f5798b/lib/client/client.ts#L14)

___

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

#### Defined in

[lib/schema/definitions.ts:118](https://github.com/redis/redis-om-node/blob/660c639/lib/schema/definitions.ts#L118)
[lib/schema/definitions.ts:123](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/definitions.ts#L123)

___

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

#### Defined in

[lib/schema/options.ts:11](https://github.com/redis/redis-om-node/blob/660c639/lib/schema/options.ts#L11)
[lib/schema/options.ts:11](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/options.ts#L11)

___

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

#### Defined in

[lib/schema/options.ts:8](https://github.com/redis/redis-om-node/blob/660c639/lib/schema/options.ts#L8)
[lib/schema/options.ts:8](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/options.ts#L8)

___

Expand All @@ -389,7 +402,7 @@ A field representing an array of strings.

#### Defined in

[lib/schema/definitions.ts:97](https://github.com/redis/redis-om-node/blob/660c639/lib/schema/definitions.ts#L97)
[lib/schema/definitions.ts:107](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/definitions.ts#L107)

___

Expand All @@ -401,7 +414,7 @@ A field representing a whole string.

#### Defined in

[lib/schema/definitions.ts:102](https://github.com/redis/redis-om-node/blob/660c639/lib/schema/definitions.ts#L102)
[lib/schema/definitions.ts:102](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/definitions.ts#L102)

___

Expand All @@ -427,7 +440,7 @@ A function that takes a [Search](classes/Search.md) and returns a [Search](class

#### Defined in

[lib/search/search.ts:26](https://github.com/redis/redis-om-node/blob/660c639/lib/search/search.ts#L26)
[lib/search/search.ts:26](https://github.com/redis/redis-om-node/blob/4f5798b/lib/search/search.ts#L26)

___

Expand All @@ -439,7 +452,7 @@ A field representing searchable text.

#### Defined in

[lib/schema/definitions.ts:107](https://github.com/redis/redis-om-node/blob/660c639/lib/schema/definitions.ts#L107)
[lib/schema/definitions.ts:112](https://github.com/redis/redis-om-node/blob/4f5798b/lib/schema/definitions.ts#L112)

## Variables

Expand All @@ -451,7 +464,7 @@ The Symbol used to access the entity ID of an [Entity](README.md#entity).

#### Defined in

[lib/entity/entity.ts:2](https://github.com/redis/redis-om-node/blob/660c639/lib/entity/entity.ts#L2)
[lib/entity/entity.ts:2](https://github.com/redis/redis-om-node/blob/4f5798b/lib/entity/entity.ts#L2)

___

Expand All @@ -463,4 +476,4 @@ The Symbol used to access the keyname of an [Entity](README.md#entity).

#### Defined in

[lib/entity/entity.ts:5](https://github.com/redis/redis-om-node/blob/660c639/lib/entity/entity.ts#L5)
[lib/entity/entity.ts:5](https://github.com/redis/redis-om-node/blob/4f5798b/lib/entity/entity.ts#L5)
Loading

0 comments on commit cf3a3dc

Please sign in to comment.