redis-type-os 1.0.3

package/docs/classes/InvalidValue.md

@@ -0,0 +1,203 @@
+[redis-om](../README.md) / InvalidValue
+
+# Class: InvalidValue
+
+## Hierarchy
+
+- [`RedisOmError`](RedisOmError.md)
+
+  ↳ **`InvalidValue`**
+
+  ↳↳ [`NullJsonValue`](NullJsonValue.md)
+
+  ↳↳ [`InvalidJsonValue`](InvalidJsonValue.md)
+
+  ↳↳ [`InvalidHashValue`](InvalidHashValue.md)
+
+## Table of contents
+
+### Constructors
+
+- [constructor](InvalidValue.md#constructor)
+
+### Properties
+
+- [cause](InvalidValue.md#cause)
+- [message](InvalidValue.md#message)
+- [name](InvalidValue.md#name)
+- [stack](InvalidValue.md#stack)
+- [prepareStackTrace](InvalidValue.md#preparestacktrace)
+- [stackTraceLimit](InvalidValue.md#stacktracelimit)
+
+### Methods
+
+- [captureStackTrace](InvalidValue.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+• **new InvalidValue**(`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 InvalidValue**(`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

package/docs/classes/NestedHashInput.md

@@ -0,0 +1,198 @@
+[redis-om](../README.md) / NestedHashInput
+
+# Class: NestedHashInput
+
+## Hierarchy
+
+- [`InvalidInput`](InvalidInput.md)
+
+  ↳ **`NestedHashInput`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](NestedHashInput.md#constructor)
+
+### Properties
+
+- [cause](NestedHashInput.md#cause)
+- [message](NestedHashInput.md#message)
+- [name](NestedHashInput.md#name)
+- [stack](NestedHashInput.md#stack)
+- [prepareStackTrace](NestedHashInput.md#preparestacktrace)
+- [stackTraceLimit](NestedHashInput.md#stacktracelimit)
+
+### Accessors
+
+- [field](NestedHashInput.md#field)
+
+### Methods
+
+- [captureStackTrace](NestedHashInput.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+• **new NestedHashInput**(`property`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `property` | `string` |
+
+#### Overrides
+
+[InvalidInput](InvalidInput.md).[constructor](InvalidInput.md#constructor)
+
+#### Defined in
+
+[lib/error/invalid-input.ts:54](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-input.ts#L54)
+
+## 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
+
+### field
+
+• `get` **field**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[lib/error/invalid-input.ts:60](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-input.ts#L60)
+
+## 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/NullJsonInput.md

@@ -0,0 +1,228 @@
+[redis-om](../README.md) / NullJsonInput
+
+# Class: NullJsonInput
+
+## Hierarchy
+
+- [`InvalidInput`](InvalidInput.md)
+
+  ↳ **`NullJsonInput`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](NullJsonInput.md#constructor)
+
+### Properties
+
+- [cause](NullJsonInput.md#cause)
+- [message](NullJsonInput.md#message)
+- [name](NullJsonInput.md#name)
+- [stack](NullJsonInput.md#stack)
+- [prepareStackTrace](NullJsonInput.md#preparestacktrace)
+- [stackTraceLimit](NullJsonInput.md#stacktracelimit)
+
+### Accessors
+
+- [fieldName](NullJsonInput.md#fieldname)
+- [fieldType](NullJsonInput.md#fieldtype)
+- [jsonPath](NullJsonInput.md#jsonpath)
+
+### Methods
+
+- [captureStackTrace](NullJsonInput.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+• **new NullJsonInput**(`field`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `field` | [`Field`](Field.md) |
+
+#### Overrides
+
+[InvalidInput](InvalidInput.md).[constructor](InvalidInput.md#constructor)
+
+#### Defined in
+
+[lib/error/invalid-input.ts:10](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-input.ts#L10)
+
+## 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:16](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-input.ts#L16)
+
+___
+
+### fieldType
+
+• `get` **fieldType**(): [`FieldType`](../README.md#fieldtype)
+
+#### Returns
+
+[`FieldType`](../README.md#fieldtype)
+
+#### Defined in
+
+[lib/error/invalid-input.ts:17](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-input.ts#L17)
+
+___
+
+### jsonPath
+
+• `get` **jsonPath**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[lib/error/invalid-input.ts:18](https://github.com/redis/redis-om-node/blob/d8438f7/lib/error/invalid-input.ts#L18)
+
+## 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