Skip to content

Commit

Permalink
typo in README
Browse files Browse the repository at this point in the history
  • Loading branch information
guyroyse committed Jul 11, 2022
1 parent f2d3aed commit fbb1430
Show file tree
Hide file tree
Showing 28 changed files with 272 additions and 272 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ const point = { longitude: 12.34, latitude: 56.78 }

A `text` field is a lot like a `string`. If you're just reading and writing objects, they are identical. But if you want to *search* on them, they are very, very different. I'll cover that in detail when I talk about [using RediSearch](#-using-redisearch) but the tl;dr is that `string` fields can only be matched on their whole value—no partial matches—and are best for keys while `text` fields have full-text search enabled on them and are optimized for human-readable text.

Additional field options can be set depending on the field type. These correspond to the [Field Options](https://redis.io/commands/ft.create/#field-options) avialable when creating a RediSearch full-text index. Other than the `separator` option, these only affect how content is indexed and searched.
Additional field options can be set depending on the field type. These correspond to the [Field Options](https://redis.io/commands/ft.create/#field-options) available when creating a RediSearch full-text index. Other than the `separator` option, these only affect how content is indexed and searched.

| schema type | RediSearch type | `indexed` | `sortable` | `normalized` | `stemming` | `phonetic` | `weight` | `separator` | `caseSensitive` |
| -------------- | :-------------: | :-------: | :--------: | :----------: | :--------: | :--------: | :------: | :---------: | :-------------: |
Expand Down
28 changes: 14 additions & 14 deletions docs/README.md
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/47d4d36/lib/search/where-point.ts#L9)
[lib/search/where-point.ts:9](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/schema/options/data-structure.ts#L2)
[lib/schema/options/data-structure.ts:2](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/entity/entity-constructor.ts#L8)
[lib/entity/entity-constructor.ts:8](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/entity/entity-data.ts#L6)
[lib/entity/entity-data.ts:6](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/entity/entity-value.ts#L6)
[lib/entity/entity-value.ts:6](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/schema/definition/field-definition.ts#L10)
[lib/schema/definition/field-definition.ts:10](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/schema/options/id-strategy.ts#L2)
[lib/schema/options/id-strategy.ts:2](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/entity/point.ts#L2)
[lib/entity/point.ts:2](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/schema/definition/schema-definition.ts#L6)
[lib/schema/definition/schema-definition.ts:6](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/schema/definition/schema-field-type.ts#L4)
[lib/schema/definition/schema-field-type.ts:4](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/schema/options/schema-options.ts#L9)
[lib/schema/options/schema-options.ts:9](https://github.com/redis/redis-om-node/blob/f2d3aed/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:23](https://github.com/redis/redis-om-node/blob/47d4d36/lib/client.ts#L23)
[lib/client.ts:23](https://github.com/redis/redis-om-node/blob/f2d3aed/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/47d4d36/lib/schema/options/stop-word-options.ts#L2)
[lib/schema/options/stop-word-options.ts:2](https://github.com/redis/redis-om-node/blob/f2d3aed/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:26](https://github.com/redis/redis-om-node/blob/47d4d36/lib/search/search.ts#L26)
[lib/search/search.ts:26](https://github.com/redis/redis-om-node/blob/f2d3aed/lib/search/search.ts#L26)
Loading

0 comments on commit fbb1430

Please sign in to comment.