redis-type-os 1.0.3

package/docs/classes/Client.md

@@ -0,0 +1,190 @@
+[redis-om](../README.md) / Client
+
+# Class: Client
+
+A Client is the starting point for working with Redis OM. Clients manage the
+connection to Redis and provide limited functionality for executing Redis commands.
+Create a client and open it before you use it:
+
+```typescript
+const client = new Client()
+await client.open()
+```
+
+A Client is primarily used by a [Repository](Repository.md) which requires a client in
+its constructor.
+
+**`Deprecated`**
+
+Just used Node Redis client directly and pass it to the Repository.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Client.md#constructor)
+
+### Accessors
+
+- [redis](Client.md#redis)
+
+### Methods
+
+- [close](Client.md#close)
+- [fetchRepository](Client.md#fetchrepository)
+- [isOpen](Client.md#isopen)
+- [open](Client.md#open)
+- [use](Client.md#use)
+- [useNoClose](Client.md#usenoclose)
+
+## Constructors
+
+### constructor
+
+• **new Client**()
+
+## Accessors
+
+### redis
+
+• `get` **redis**(): `undefined` \| [`RedisConnection`](../README.md#redisconnection)
+
+Returns the underlying Node Redis connection being used.
+
+#### Returns
+
+`undefined` \| [`RedisConnection`](../README.md#redisconnection)
+
+#### Defined in
+
+[lib/client/client.ts:70](https://github.com/redis/redis-om-node/blob/d8438f7/lib/client/client.ts#L70)
+
+## Methods
+
+### close
+
+▸ **close**(): `Promise`<`void`\>
+
+Close the connection to Redis.
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[lib/client/client.ts:127](https://github.com/redis/redis-om-node/blob/d8438f7/lib/client/client.ts#L127)
+
+___
+
+### fetchRepository
+
+▸ **fetchRepository**(`schema`): [`Repository`](Repository.md)
+
+Creates a repository for the given schema.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `schema` | [`Schema`](Schema.md) | The schema. |
+
+#### Returns
+
+[`Repository`](Repository.md)
+
+A repository for the provided schema.
+
+#### Defined in
+
+[lib/client/client.ts:119](https://github.com/redis/redis-om-node/blob/d8438f7/lib/client/client.ts#L119)
+
+___
+
+### isOpen
+
+▸ **isOpen**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+Whether a connection is already open.
+
+#### Defined in
+
+[lib/client/client.ts:213](https://github.com/redis/redis-om-node/blob/d8438f7/lib/client/client.ts#L213)
+
+___
+
+### open
+
+▸ **open**(`url?`): `Promise`<[`Client`](Client.md)\>
+
+Open a connection to Redis at the provided URL.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `url` | `string` | `'redis://localhost:6379'` | A URL to Redis as defined with the [IANA](https://www.iana.org/assignments/uri-schemes/prov/redis). |
+
+#### Returns
+
+`Promise`<[`Client`](Client.md)\>
+
+This [Client](Client.md) instance.
+
+#### Defined in
+
+[lib/client/client.ts:104](https://github.com/redis/redis-om-node/blob/d8438f7/lib/client/client.ts#L104)
+
+___
+
+### use
+
+▸ **use**(`connection`): `Promise`<[`Client`](Client.md)\>
+
+Attaches an existing Node Redis connection to this Redis OM client. Closes
+any existing connection.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `connection` | [`RedisConnection`](../README.md#redisconnection) | An existing Node Redis client. |
+
+#### Returns
+
+`Promise`<[`Client`](Client.md)\>
+
+This [Client](Client.md) instance.
+
+#### Defined in
+
+[lib/client/client.ts:81](https://github.com/redis/redis-om-node/blob/d8438f7/lib/client/client.ts#L81)
+
+___
+
+### useNoClose
+
+▸ **useNoClose**(`connection`): [`Client`](Client.md)
+
+Attaches an existing Node Redis connection to this Redis OM client. Does
+not close any existing connection.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `connection` | [`RedisConnection`](../README.md#redisconnection) | An existing Node Redis client. |
+
+#### Returns
+
+[`Client`](Client.md)
+
+This [Client](Client.md) instance.
+
+#### Defined in
+
+[lib/client/client.ts:93](https://github.com/redis/redis-om-node/blob/d8438f7/lib/client/client.ts#L93)

package/docs/classes/Field.md

@@ -0,0 +1,254 @@
+[redis-om](../README.md) / Field
+
+# Class: Field
+
+Describes a field in a [Schema](Schema.md).
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Field.md#constructor)
+
+### Accessors
+
+- [caseSensitive](Field.md#casesensitive)
+- [hashField](Field.md#hashfield)
+- [indexed](Field.md#indexed)
+- [isArray](Field.md#isarray)
+- [jsonPath](Field.md#jsonpath)
+- [matcher](Field.md#matcher)
+- [name](Field.md#name)
+- [normalized](Field.md#normalized)
+- [separator](Field.md#separator)
+- [sortable](Field.md#sortable)
+- [stemming](Field.md#stemming)
+- [type](Field.md#type)
+- [weight](Field.md#weight)
+
+## Constructors
+
+### constructor
+
+• **new Field**(`name`, `definition`)
+
+Creates a Field.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `name` | `string` | The name of the Field. |
+| `definition` | [`FieldDefinition`](../README.md#fielddefinition) | The underlying [FieldDefinition](../README.md#fielddefinition). |
+
+#### Defined in
+
+[lib/schema/field.ts:17](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L17)
+
+## Accessors
+
+### caseSensitive
+
+• `get` **caseSensitive**(): `boolean`
+
+The case-sensitivity of the field.
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[lib/schema/field.ts:55](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L55)
+
+___
+
+### hashField
+
+• `get` **hashField**(): `string`
+
+The field name used to store this [Field](Field.md) in a Hash.
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[lib/schema/field.ts:33](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L33)
+
+___
+
+### indexed
+
+• `get` **indexed**(): `boolean`
+
+Indicates the field as being indexed—and thus queryable—by RediSearch.
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[lib/schema/field.ts:60](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L60)
+
+___
+
+### isArray
+
+• `get` **isArray**(): `boolean`
+
+Is this type an array or not.
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[lib/schema/field.ts:85](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L85)
+
+___
+
+### jsonPath
+
+• `get` **jsonPath**(): `string`
+
+The JSONPath used to store this [Field](Field.md) in a JSON document.
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[lib/schema/field.ts:38](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L38)
+
+___
+
+### matcher
+
+• `get` **matcher**(): ``null`` \| `string`
+
+The phonetic matcher for the field.
+
+#### Returns
+
+``null`` \| `string`
+
+#### Defined in
+
+[lib/schema/field.ts:80](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L80)
+
+___
+
+### name
+
+• `get` **name**(): `string`
+
+The name of the field.
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[lib/schema/field.ts:23](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L23)
+
+___
+
+### normalized
+
+• `get` **normalized**(): `boolean`
+
+Indicates that the field is normalized. Ignored if sortable is false.
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[lib/schema/field.ts:70](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L70)
+
+___
+
+### separator
+
+• `get` **separator**(): `string`
+
+The separator for string[] fields when stored in Hashes.
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[lib/schema/field.ts:45](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L45)
+
+___
+
+### sortable
+
+• `get` **sortable**(): `boolean`
+
+Indicates that the field as sortable.
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[lib/schema/field.ts:50](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L50)
+
+___
+
+### stemming
+
+• `get` **stemming**(): `boolean`
+
+Indicates that the field as indexed with stemming support.
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[lib/schema/field.ts:65](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L65)
+
+___
+
+### type
+
+• `get` **type**(): [`FieldType`](../README.md#fieldtype)
+
+The [type](../README.md#fieldtype) of the field.
+
+#### Returns
+
+[`FieldType`](../README.md#fieldtype)
+
+#### Defined in
+
+[lib/schema/field.ts:28](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L28)
+
+___
+
+### weight
+
+• `get` **weight**(): ``null`` \| `number`
+
+The search weight of the field.
+
+#### Returns
+
+``null`` \| `number`
+
+#### Defined in
+
+[lib/schema/field.ts:75](https://github.com/redis/redis-om-node/blob/d8438f7/lib/schema/field.ts#L75)

package/docs/classes/FieldNotInSchema.md

@@ -0,0 +1,198 @@
+[redis-om](../README.md) / FieldNotInSchema
+
+# Class: FieldNotInSchema
+
+## Hierarchy
+
+- [`SearchError`](SearchError.md)
+
+  ↳ **`FieldNotInSchema`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](FieldNotInSchema.md#constructor)
+
+### Properties
+
+- [cause](FieldNotInSchema.md#cause)
+- [message](FieldNotInSchema.md#message)
+- [name](FieldNotInSchema.md#name)
+- [stack](FieldNotInSchema.md#stack)
+- [prepareStackTrace](FieldNotInSchema.md#preparestacktrace)
+- [stackTraceLimit](FieldNotInSchema.md#stacktracelimit)
+
+### Accessors
+
+- [field](FieldNotInSchema.md#field)
+
+### Methods
+
+- [captureStackTrace](FieldNotInSchema.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+• **new FieldNotInSchema**(`fieldName`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `fieldName` | `string` |
+
+#### Overrides
+
+[SearchError](SearchError.md).[constructor](SearchError.md#constructor)
+
+#### Defined in
+
+[lib/error/search-error.ts:11](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/search-error.ts#L11)
+
+## Properties
+
+### cause
+
+• `Optional` **cause**: `unknown`
+
+#### Inherited from
+
+[SearchError](SearchError.md).[cause](SearchError.md#cause)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es2022.error.d.ts:26
+
+___
+
+### message
+
+• **message**: `string`
+
+#### Inherited from
+
+[SearchError](SearchError.md).[message](SearchError.md#message)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1054
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Inherited from
+
+[SearchError](SearchError.md).[name](SearchError.md#name)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1053
+
+___
+
+### stack
+
+• `Optional` **stack**: `string`
+
+#### Inherited from
+
+[SearchError](SearchError.md).[stack](SearchError.md#stack)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1055
+
+___
+
+### prepareStackTrace
+
+▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
+
+#### Type declaration
+
+▸ (`err`, `stackTraces`): `any`
+
+Optional override for formatting stack traces
+
+**`See`**
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `err` | `Error` |
+| `stackTraces` | `CallSite`[] |
+
+##### Returns
+
+`any`
+
+#### Inherited from
+
+[SearchError](SearchError.md).[prepareStackTrace](SearchError.md#preparestacktrace)
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:11
+
+___
+
+### stackTraceLimit
+
+▪ `Static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+[SearchError](SearchError.md).[stackTraceLimit](SearchError.md#stacktracelimit)
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:13
+
+## Accessors
+
+### field
+
+• `get` **field**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[lib/error/search-error.ts:16](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/search-error.ts#L16)
+
+## Methods
+
+### captureStackTrace
+
+▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Create .stack property on a target object
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `targetObject` | `object` |
+| `constructorOpt?` | `Function` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[SearchError](SearchError.md).[captureStackTrace](SearchError.md#capturestacktrace)
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:4