redis-om-type 1.0.0

package/docs/classes/ArrayHashInput.md

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

@@ -0,0 +1,375 @@
+[redis-om](../README.md) / Circle
+
+# Class: Circle
+
+A builder that defines a circle.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Circle.md#constructor)
+
+### Accessors
+
+- [feet](Circle.md#feet)
+- [foot](Circle.md#foot)
+- [ft](Circle.md#ft)
+- [kilometer](Circle.md#kilometer)
+- [kilometers](Circle.md#kilometers)
+- [km](Circle.md#km)
+- [m](Circle.md#m)
+- [meter](Circle.md#meter)
+- [meters](Circle.md#meters)
+- [mi](Circle.md#mi)
+- [mile](Circle.md#mile)
+- [miles](Circle.md#miles)
+
+### Methods
+
+- [latitude](Circle.md#latitude)
+- [longitude](Circle.md#longitude)
+- [origin](Circle.md#origin)
+- [radius](Circle.md#radius)
+
+## Constructors
+
+### constructor
+
+• **new Circle**()
+
+## Accessors
+
+### feet
+
+• `get` **feet**(): `this`
+
+Sets the units to feet.
+
+#### Returns
+
+`this`
+
+This instance.
+
+#### Defined in
+
+[lib/search/where-point.ts:149](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L149)
+
+___
+
+### foot
+
+• `get` **foot**(): `this`
+
+Sets the units to feet.
+
+#### Returns
+
+`this`
+
+This instance.
+
+#### Defined in
+
+[lib/search/where-point.ts:143](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L143)
+
+___
+
+### ft
+
+• `get` **ft**(): `this`
+
+Sets the units to feet.
+
+#### Returns
+
+`this`
+
+This instance.
+
+#### Defined in
+
+[lib/search/where-point.ts:137](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L137)
+
+___
+
+### kilometer
+
+• `get` **kilometer**(): `this`
+
+Sets the units to kilometers.
+
+#### Returns
+
+`this`
+
+This instance.
+
+#### Defined in
+
+[lib/search/where-point.ts:122](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L122)
+
+___
+
+### kilometers
+
+• `get` **kilometers**(): `this`
+
+Sets the units to kilometers.
+
+#### Returns
+
+`this`
+
+This instance.
+
+#### Defined in
+
+[lib/search/where-point.ts:128](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L128)
+
+___
+
+### km
+
+• `get` **km**(): `this`
+
+Sets the units to kilometers.
+
+#### Returns
+
+`this`
+
+This instance.
+
+#### Defined in
+
+[lib/search/where-point.ts:116](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L116)
+
+___
+
+### m
+
+• `get` **m**(): `this`
+
+Sets the units to meters.
+
+#### Returns
+
+`this`
+
+This instance.
+
+#### Defined in
+
+[lib/search/where-point.ts:95](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L95)
+
+___
+
+### meter
+
+• `get` **meter**(): `this`
+
+Sets the units to meters.
+
+#### Returns
+
+`this`
+
+This instance.
+
+#### Defined in
+
+[lib/search/where-point.ts:101](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L101)
+
+___
+
+### meters
+
+• `get` **meters**(): `this`
+
+Sets the units to meters.
+
+#### Returns
+
+`this`
+
+This instance.
+
+#### Defined in
+
+[lib/search/where-point.ts:107](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L107)
+
+___
+
+### mi
+
+• `get` **mi**(): `this`
+
+Sets the units to miles.
+
+#### Returns
+
+`this`
+
+This instance.
+
+#### Defined in
+
+[lib/search/where-point.ts:158](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L158)
+
+___
+
+### mile
+
+• `get` **mile**(): `this`
+
+Sets the units to miles.
+
+#### Returns
+
+`this`
+
+This instance.
+
+#### Defined in
+
+[lib/search/where-point.ts:164](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L164)
+
+___
+
+### miles
+
+• `get` **miles**(): `this`
+
+Sets the units to miles.
+
+#### Returns
+
+`this`
+
+This instance.
+
+#### Defined in
+
+[lib/search/where-point.ts:170](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L170)
+
+## Methods
+
+### latitude
+
+▸ **latitude**(`value`): [`Circle`](Circle.md)
+
+Sets the latitude. If not set, defaults to 0.0.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `value` | `number` | The latitude. |
+
+#### Returns
+
+[`Circle`](Circle.md)
+
+This instance.
+
+#### Defined in
+
+[lib/search/where-point.ts:42](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L42)
+
+___
+
+### longitude
+
+▸ **longitude**(`value`): [`Circle`](Circle.md)
+
+Sets the longitude. If not set, defaults to 0.0.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `value` | `number` | The longitude. |
+
+#### Returns
+
+[`Circle`](Circle.md)
+
+This instance.
+
+#### Defined in
+
+[lib/search/where-point.ts:31](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L31)
+
+___
+
+### origin
+
+▸ **origin**(`point`): [`Circle`](Circle.md)
+
+Sets the origin of the circle using a [Point](../README.md#point). If not
+set, defaults to [Null Island](https://en.wikipedia.org/wiki/Null_Island).
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `point` | [`Point`](../README.md#point) | A [Point](../README.md#point) containing the longitude and latitude of the origin. |
+
+#### Returns
+
+[`Circle`](Circle.md)
+
+This instance.
+
+#### Defined in
+
+[lib/search/where-point.ts:54](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L54)
+
+▸ **origin**(`longitude`, `latitude`): [`Circle`](Circle.md)
+
+Sets the origin of the circle. If not set, defaults to
+[Null Island](https://en.wikipedia.org/wiki/Null_Island).
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `longitude` | `number` | The longitude. |
+| `latitude` | `number` | The latitude. |
+
+#### Returns
+
+[`Circle`](Circle.md)
+
+This instance.
+
+#### Defined in
+
+[lib/search/where-point.ts:64](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L64)
+
+___
+
+### radius
+
+▸ **radius**(`size`): [`Circle`](Circle.md)
+
+Sets the radius of the [Circle](Circle.md). Defaults to 1. If units are
+not specified, defaults to meters.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `size` | `number` | The radius of the circle. |
+
+#### Returns
+
+[`Circle`](Circle.md)
+
+This instance.
+
+#### Defined in
+
+[lib/search/where-point.ts:86](https://github.com/redis/redis-om-node/blob/d8438f7/lib/search/where-point.ts#L86)