Skip to content

Commit

Permalink
updated typedoc for a typo
Browse files Browse the repository at this point in the history
  • Loading branch information
guyroyse committed Dec 17, 2021
1 parent 3233465 commit a4b715e
Show file tree
Hide file tree
Showing 15 changed files with 84 additions and 84 deletions.
18 changes: 9 additions & 9 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ A constructor that creates an [Entity](classes/Entity.md) of type TEntity.

#### Defined in

[lib/entity/entity.ts:10](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/entity/entity.ts#L10)
[lib/entity/entity.ts:10](https://github.com/redis/redis-om-node/blob/3233465/lib/entity/entity.ts#L10)

___

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

#### Defined in

[lib/entity/entity.ts:4](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/entity/entity.ts#L4)
[lib/entity/entity.ts:4](https://github.com/redis/redis-om-node/blob/3233465/lib/entity/entity.ts#L4)

___

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

#### Defined in

[lib/schema/schema-definitions.ts:54](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/schema/schema-definitions.ts#L54)
[lib/schema/schema-definitions.ts:54](https://github.com/redis/redis-om-node/blob/3233465/lib/schema/schema-definitions.ts#L54)

___

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

#### Defined in

[lib/schema/schema-definitions.ts:68](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/schema/schema-definitions.ts#L68)
[lib/schema/schema-definitions.ts:68](https://github.com/redis/redis-om-node/blob/3233465/lib/schema/schema-definitions.ts#L68)

___

Expand All @@ -129,7 +129,7 @@ contains a [FieldDefinition](README.md#fielddefinition) that tell Redis OM how t

#### Defined in

[lib/schema/schema-definitions.ts:59](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/schema/schema-definitions.ts#L59)
[lib/schema/schema-definitions.ts:59](https://github.com/redis/redis-om-node/blob/3233465/lib/schema/schema-definitions.ts#L59)

___

Expand All @@ -152,7 +152,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/2dfb2f0/lib/schema/schema-options.ts#L7)
[lib/schema/schema-options.ts:7](https://github.com/redis/redis-om-node/blob/3233465/lib/schema/schema-options.ts#L7)

___

Expand All @@ -164,7 +164,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/2dfb2f0/lib/client.ts#L21)
[lib/client.ts:21](https://github.com/redis/redis-om-node/blob/3233465/lib/client.ts#L21)

___

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

#### Defined in

[lib/schema/schema-definitions.ts:71](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/schema/schema-definitions.ts#L71)
[lib/schema/schema-definitions.ts:71](https://github.com/redis/redis-om-node/blob/3233465/lib/schema/schema-definitions.ts#L71)

___

Expand Down Expand Up @@ -208,4 +208,4 @@ A function that takes a [Search](classes/Search.md) and returns a [Search](class

#### Defined in

[lib/search/search.ts:22](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/search/search.ts#L22)
[lib/search/search.ts:22](https://github.com/redis/redis-om-node/blob/3233465/lib/search/search.ts#L22)
8 changes: 4 additions & 4 deletions docs/classes/Client.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Close the connection to Redis.

#### Defined in

[lib/client.ts:96](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/client.ts#L96)
[lib/client.ts:96](https://github.com/redis/redis-om-node/blob/3233465/lib/client.ts#L96)

___

Expand Down Expand Up @@ -77,7 +77,7 @@ The raw results of calling the Redis command.

#### Defined in

[lib/client.ts:73](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/client.ts#L73)
[lib/client.ts:73](https://github.com/redis/redis-om-node/blob/3233465/lib/client.ts#L73)

___

Expand Down Expand Up @@ -107,7 +107,7 @@ A repository for the provided schema.

#### Defined in

[lib/client.ts:88](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/client.ts#L88)
[lib/client.ts:88](https://github.com/redis/redis-om-node/blob/3233465/lib/client.ts#L88)

___

Expand All @@ -129,4 +129,4 @@ Open a connection to Redis at the provided URL.

#### Defined in

[lib/client.ts:60](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/client.ts#L60)
[lib/client.ts:60](https://github.com/redis/redis-om-node/blob/3233465/lib/client.ts#L60)
2 changes: 1 addition & 1 deletion docs/classes/Entity.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ The generated entity ID.

#### Defined in

[lib/entity/entity.ts:22](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/entity/entity.ts#L22)
[lib/entity/entity.ts:22](https://github.com/redis/redis-om-node/blob/3233465/lib/entity/entity.ts#L22)
2 changes: 1 addition & 1 deletion docs/classes/RedisError.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Error.constructor

#### Defined in

[lib/errors.ts:2](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/errors.ts#L2)
[lib/errors.ts:2](https://github.com/redis/redis-om-node/blob/3233465/lib/errors.ts#L2)

## Properties

Expand Down
16 changes: 8 additions & 8 deletions docs/classes/Repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Constructs a new Repository.

#### Defined in

[lib/repository/repository.ts:60](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/repository/repository.ts#L60)
[lib/repository/repository.ts:60](https://github.com/redis/redis-om-node/blob/3233465/lib/repository/repository.ts#L60)

## Methods

Expand All @@ -100,7 +100,7 @@ A newly created Entity.

#### Defined in

[lib/repository/repository.ts:106](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/repository/repository.ts#L106)
[lib/repository/repository.ts:106](https://github.com/redis/redis-om-node/blob/3233465/lib/repository/repository.ts#L106)

___

Expand All @@ -117,7 +117,7 @@ that RediSearch or RedisJSON is installed on your instance of Redis.

#### Defined in

[lib/repository/repository.ts:71](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/repository/repository.ts#L71)
[lib/repository/repository.ts:71](https://github.com/redis/redis-om-node/blob/3233465/lib/repository/repository.ts#L71)

___

Expand All @@ -135,7 +135,7 @@ on your instance of Redis.

#### Defined in

[lib/repository/repository.ts:90](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/repository/repository.ts#L90)
[lib/repository/repository.ts:90](https://github.com/redis/redis-om-node/blob/3233465/lib/repository/repository.ts#L90)

___

Expand All @@ -161,7 +161,7 @@ The matching Entity.

#### Defined in

[lib/repository/repository.ts:144](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/repository/repository.ts#L144)
[lib/repository/repository.ts:144](https://github.com/redis/redis-om-node/blob/3233465/lib/repository/repository.ts#L144)

___

Expand All @@ -184,7 +184,7 @@ not found, does nothing.

#### Defined in

[lib/repository/repository.ts:165](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/repository/repository.ts#L165)
[lib/repository/repository.ts:165](https://github.com/redis/redis-om-node/blob/3233465/lib/repository/repository.ts#L165)

___

Expand All @@ -209,7 +209,7 @@ The ID of the Entity just saved.

#### Defined in

[lib/repository/repository.ts:117](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/repository/repository.ts#L117)
[lib/repository/repository.ts:117](https://github.com/redis/redis-om-node/blob/3233465/lib/repository/repository.ts#L117)

___

Expand All @@ -228,4 +228,4 @@ A [Search](Search.md) object.

#### Defined in

[lib/repository/repository.ts:176](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/repository/repository.ts#L176)
[lib/repository/repository.ts:176](https://github.com/redis/redis-om-node/blob/3233465/lib/repository/repository.ts#L176)
16 changes: 8 additions & 8 deletions docs/classes/Schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ let schema = new Schema(Foo, {
aBoolean: { type: 'boolean' },
anArray: { type: 'array' }
}, {
dataStructure: 'JSON
dataStructure: 'JSON'
});
```

Expand Down Expand Up @@ -66,7 +66,7 @@ its constructor.

#### Defined in

[lib/schema/schema.ts:53](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/schema/schema.ts#L53)
[lib/schema/schema.ts:53](https://github.com/redis/redis-om-node/blob/3233465/lib/schema/schema.ts#L53)

## Accessors

Expand All @@ -83,7 +83,7 @@ that this Schema uses to store [Entities](Entity.md) in Redis.

#### Defined in

[lib/schema/schema.ts:72](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/schema/schema.ts#L72)
[lib/schema/schema.ts:72](https://github.com/redis/redis-om-node/blob/3233465/lib/schema/schema.ts#L72)

___

Expand All @@ -99,7 +99,7 @@ The configured name for the RediSearch index for this Schema.

#### Defined in

[lib/schema/schema.ts:66](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/schema/schema.ts#L66)
[lib/schema/schema.ts:66](https://github.com/redis/redis-om-node/blob/3233465/lib/schema/schema.ts#L66)

___

Expand All @@ -115,7 +115,7 @@ The configured keyspace prefix in Redis for this Schema.

#### Defined in

[lib/schema/schema.ts:63](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/schema/schema.ts#L63)
[lib/schema/schema.ts:63](https://github.com/redis/redis-om-node/blob/3233465/lib/schema/schema.ts#L63)

___

Expand All @@ -132,7 +132,7 @@ than `CUSTOM`.

#### Defined in

[lib/schema/schema.ts:85](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/schema/schema.ts#L85)
[lib/schema/schema.ts:85](https://github.com/redis/redis-om-node/blob/3233465/lib/schema/schema.ts#L85)

___

Expand All @@ -150,7 +150,7 @@ for more details.

#### Defined in

[lib/schema/schema.ts:79](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/schema/schema.ts#L79)
[lib/schema/schema.ts:79](https://github.com/redis/redis-om-node/blob/3233465/lib/schema/schema.ts#L79)

## Methods

Expand All @@ -166,4 +166,4 @@ Generates a unique string using the configured [IdStrategy](../README.md#idstrat

#### Defined in

[lib/schema/schema.ts:94](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/schema/schema.ts#L94)
[lib/schema/schema.ts:94](https://github.com/redis/redis-om-node/blob/3233465/lib/schema/schema.ts#L94)
18 changes: 9 additions & 9 deletions docs/classes/Search.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ A subclass of [WhereField](WhereField.md) matching the type of the field.

#### Defined in

[lib/search/search.ts:125](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/search/search.ts#L125)
[lib/search/search.ts:125](https://github.com/redis/redis-om-node/blob/3233465/lib/search/search.ts#L125)

**and**(`subSearchFn`): [`Search`](Search.md)<`TEntity`\>

Expand All @@ -63,7 +63,7 @@ Sets up a nested search as a logical AND.

#### Defined in

[lib/search/search.ts:132](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/search/search.ts#L132)
[lib/search/search.ts:132](https://github.com/redis/redis-om-node/blob/3233465/lib/search/search.ts#L132)

___

Expand All @@ -79,7 +79,7 @@ Returns the number of [Entities](Entity.md) that match this query.

#### Defined in

[lib/search/search.ts:52](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/search/search.ts#L52)
[lib/search/search.ts:52](https://github.com/redis/redis-om-node/blob/3233465/lib/search/search.ts#L52)

___

Expand All @@ -103,7 +103,7 @@ A subclass of [WhereField](WhereField.md) matching the type of the field.

#### Defined in

[lib/search/search.ts:142](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/search/search.ts#L142)
[lib/search/search.ts:142](https://github.com/redis/redis-om-node/blob/3233465/lib/search/search.ts#L142)

**or**(`subSearchFn`): [`Search`](Search.md)<`TEntity`\>

Expand All @@ -123,7 +123,7 @@ Sets up a nested search as a logical OR.

#### Defined in

[lib/search/search.ts:149](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/search/search.ts#L149)
[lib/search/search.ts:149](https://github.com/redis/redis-om-node/blob/3233465/lib/search/search.ts#L149)

___

Expand All @@ -148,7 +148,7 @@ An array of [Entities](Entity.md) matching the query.

#### Defined in

[lib/search/search.ts:65](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/search/search.ts#L65)
[lib/search/search.ts:65](https://github.com/redis/redis-om-node/blob/3233465/lib/search/search.ts#L65)

___

Expand Down Expand Up @@ -180,7 +180,7 @@ An array of [Entities](Entity.md) matching the query.

#### Defined in

[lib/search/search.ts:86](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/search/search.ts#L86)
[lib/search/search.ts:86](https://github.com/redis/redis-om-node/blob/3233465/lib/search/search.ts#L86)

___

Expand All @@ -205,7 +205,7 @@ A subclass of [WhereField](WhereField.md) matching the type of the field.

#### Defined in

[lib/search/search.ts:107](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/search/search.ts#L107)
[lib/search/search.ts:107](https://github.com/redis/redis-om-node/blob/3233465/lib/search/search.ts#L107)

**where**(`subSearchFn`): [`Search`](Search.md)<`TEntity`\>

Expand All @@ -226,4 +226,4 @@ they are treated logically as AND.

#### Defined in

[lib/search/search.ts:115](https://github.com/redis/redis-om-node/blob/2dfb2f0/lib/search/search.ts#L115)
[lib/search/search.ts:115](https://github.com/redis/redis-om-node/blob/3233465/lib/search/search.ts#L115)
2 changes: 1 addition & 1 deletion docs/classes/Where.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/2dfb2f0/lib/search/where.ts#L8)
[lib/search/where.ts:8](https://github.com/redis/redis-om-node/blob/3233465/lib/search/where.ts#L8)
Loading

0 comments on commit a4b715e

Please sign in to comment.