redis-type-os 1.0.3

package/docs/classes/InvalidHashInput.md

@@ -0,0 +1,213 @@
+[redis-om](../README.md) / InvalidHashInput
+
+# Class: InvalidHashInput
+
+## Hierarchy
+
+- [`InvalidInput`](InvalidInput.md)
+
+  ↳ **`InvalidHashInput`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](InvalidHashInput.md#constructor)
+
+### Properties
+
+- [cause](InvalidHashInput.md#cause)
+- [message](InvalidHashInput.md#message)
+- [name](InvalidHashInput.md#name)
+- [stack](InvalidHashInput.md#stack)
+- [prepareStackTrace](InvalidHashInput.md#preparestacktrace)
+- [stackTraceLimit](InvalidHashInput.md#stacktracelimit)
+
+### Accessors
+
+- [fieldName](InvalidHashInput.md#fieldname)
+- [fieldType](InvalidHashInput.md#fieldtype)
+
+### Methods
+
+- [captureStackTrace](InvalidHashInput.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+• **new InvalidHashInput**(`field`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `field` | [`Field`](Field.md) |
+
+#### Overrides
+
+[InvalidInput](InvalidInput.md).[constructor](InvalidInput.md#constructor)
+
+#### Defined in
+
+[lib/error/invalid-input.ts:40](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-input.ts#L40)
+
+## Properties
+
+### cause
+
+• `Optional` **cause**: `unknown`
+
+#### Inherited from
+
+[InvalidInput](InvalidInput.md).[cause](InvalidInput.md#cause)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es2022.error.d.ts:26
+
+___
+
+### message
+
+• **message**: `string`
+
+#### Inherited from
+
+[InvalidInput](InvalidInput.md).[message](InvalidInput.md#message)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1054
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Inherited from
+
+[InvalidInput](InvalidInput.md).[name](InvalidInput.md#name)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1053
+
+___
+
+### stack
+
+• `Optional` **stack**: `string`
+
+#### Inherited from
+
+[InvalidInput](InvalidInput.md).[stack](InvalidInput.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
+
+[InvalidInput](InvalidInput.md).[prepareStackTrace](InvalidInput.md#preparestacktrace)
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:11
+
+___
+
+### stackTraceLimit
+
+▪ `Static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+[InvalidInput](InvalidInput.md).[stackTraceLimit](InvalidInput.md#stacktracelimit)
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:13
+
+## Accessors
+
+### fieldName
+
+• `get` **fieldName**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[lib/error/invalid-input.ts:46](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-input.ts#L46)
+
+___
+
+### fieldType
+
+• `get` **fieldType**(): [`FieldType`](../README.md#fieldtype)
+
+#### Returns
+
+[`FieldType`](../README.md#fieldtype)
+
+#### Defined in
+
+[lib/error/invalid-input.ts:47](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-input.ts#L47)
+
+## 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
+
+[InvalidInput](InvalidInput.md).[captureStackTrace](InvalidInput.md#capturestacktrace)
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:4

package/docs/classes/InvalidHashValue.md

@@ -0,0 +1,228 @@
+[redis-om](../README.md) / InvalidHashValue
+
+# Class: InvalidHashValue
+
+## Hierarchy
+
+- [`InvalidValue`](InvalidValue.md)
+
+  ↳ **`InvalidHashValue`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](InvalidHashValue.md#constructor)
+
+### Properties
+
+- [cause](InvalidHashValue.md#cause)
+- [message](InvalidHashValue.md#message)
+- [name](InvalidHashValue.md#name)
+- [stack](InvalidHashValue.md#stack)
+- [prepareStackTrace](InvalidHashValue.md#preparestacktrace)
+- [stackTraceLimit](InvalidHashValue.md#stacktracelimit)
+
+### Accessors
+
+- [fieldName](InvalidHashValue.md#fieldname)
+- [fieldType](InvalidHashValue.md#fieldtype)
+- [hashField](InvalidHashValue.md#hashfield)
+
+### Methods
+
+- [captureStackTrace](InvalidHashValue.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+• **new InvalidHashValue**(`field`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `field` | [`Field`](Field.md) |
+
+#### Overrides
+
+[InvalidValue](InvalidValue.md).[constructor](InvalidValue.md#constructor)
+
+#### Defined in
+
+[lib/error/invalid-value.ts:40](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-value.ts#L40)
+
+## Properties
+
+### cause
+
+• `Optional` **cause**: `unknown`
+
+#### Inherited from
+
+[InvalidValue](InvalidValue.md).[cause](InvalidValue.md#cause)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es2022.error.d.ts:26
+
+___
+
+### message
+
+• **message**: `string`
+
+#### Inherited from
+
+[InvalidValue](InvalidValue.md).[message](InvalidValue.md#message)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1054
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Inherited from
+
+[InvalidValue](InvalidValue.md).[name](InvalidValue.md#name)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1053
+
+___
+
+### stack
+
+• `Optional` **stack**: `string`
+
+#### Inherited from
+
+[InvalidValue](InvalidValue.md).[stack](InvalidValue.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
+
+[InvalidValue](InvalidValue.md).[prepareStackTrace](InvalidValue.md#preparestacktrace)
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:11
+
+___
+
+### stackTraceLimit
+
+▪ `Static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+[InvalidValue](InvalidValue.md).[stackTraceLimit](InvalidValue.md#stacktracelimit)
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:13
+
+## Accessors
+
+### fieldName
+
+• `get` **fieldName**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[lib/error/invalid-value.ts:46](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-value.ts#L46)
+
+___
+
+### fieldType
+
+• `get` **fieldType**(): [`FieldType`](../README.md#fieldtype)
+
+#### Returns
+
+[`FieldType`](../README.md#fieldtype)
+
+#### Defined in
+
+[lib/error/invalid-value.ts:47](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-value.ts#L47)
+
+___
+
+### hashField
+
+• `get` **hashField**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[lib/error/invalid-value.ts:48](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-value.ts#L48)
+
+## 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
+
+[InvalidValue](InvalidValue.md).[captureStackTrace](InvalidValue.md#capturestacktrace)
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:4

package/docs/classes/InvalidInput.md

@@ -0,0 +1,207 @@
+[redis-om](../README.md) / InvalidInput
+
+# Class: InvalidInput
+
+## Hierarchy
+
+- [`RedisOmError`](RedisOmError.md)
+
+  ↳ **`InvalidInput`**
+
+  ↳↳ [`NullJsonInput`](NullJsonInput.md)
+
+  ↳↳ [`InvalidJsonInput`](InvalidJsonInput.md)
+
+  ↳↳ [`InvalidHashInput`](InvalidHashInput.md)
+
+  ↳↳ [`NestedHashInput`](NestedHashInput.md)
+
+  ↳↳ [`ArrayHashInput`](ArrayHashInput.md)
+
+## Table of contents
+
+### Constructors
+
+- [constructor](InvalidInput.md#constructor)
+
+### Properties
+
+- [cause](InvalidInput.md#cause)
+- [message](InvalidInput.md#message)
+- [name](InvalidInput.md#name)
+- [stack](InvalidInput.md#stack)
+- [prepareStackTrace](InvalidInput.md#preparestacktrace)
+- [stackTraceLimit](InvalidInput.md#stacktracelimit)
+
+### Methods
+
+- [captureStackTrace](InvalidInput.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+• **new InvalidInput**(`message?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `message?` | `string` |
+
+#### Inherited from
+
+[RedisOmError](RedisOmError.md).[constructor](RedisOmError.md#constructor)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1059
+
+• **new InvalidInput**(`message?`, `options?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `message?` | `string` |
+| `options?` | `ErrorOptions` |
+
+#### Inherited from
+
+[RedisOmError](RedisOmError.md).[constructor](RedisOmError.md#constructor)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es2022.error.d.ts:30
+
+## Properties
+
+### cause
+
+• `Optional` **cause**: `unknown`
+
+#### Inherited from
+
+[RedisOmError](RedisOmError.md).[cause](RedisOmError.md#cause)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es2022.error.d.ts:26
+
+___
+
+### message
+
+• **message**: `string`
+
+#### Inherited from
+
+[RedisOmError](RedisOmError.md).[message](RedisOmError.md#message)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1054
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Inherited from
+
+[RedisOmError](RedisOmError.md).[name](RedisOmError.md#name)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1053
+
+___
+
+### stack
+
+• `Optional` **stack**: `string`
+
+#### Inherited from
+
+[RedisOmError](RedisOmError.md).[stack](RedisOmError.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
+
+[RedisOmError](RedisOmError.md).[prepareStackTrace](RedisOmError.md#preparestacktrace)
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:11
+
+___
+
+### stackTraceLimit
+
+▪ `Static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+[RedisOmError](RedisOmError.md).[stackTraceLimit](RedisOmError.md#stacktracelimit)
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:13
+
+## 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
+
+[RedisOmError](RedisOmError.md).[captureStackTrace](RedisOmError.md#capturestacktrace)
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:4