redis-om-type 1.0.0

package/docs/classes/RedisOmError.md

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

package/docs/classes/Repository.md

@@ -0,0 +1,425 @@
+[redis-om](../README.md) / Repository
+
+# Class: Repository
+
+A repository is the main interaction point for reading, writing, and
+removing [Entities](../README.md#entity) from Redis. Create one by calling
+[fetchRepository](Client.md#fetchrepository) and passing in a [Schema](Schema.md). Then
+use the [fetch](Repository.md#fetch), [save](Repository.md#save), and
+[remove](Repository.md#remove) methods to manage your data:
+
+```typescript
+const repository = client.fetchRepository(schema)
+
+const foo = await repository.fetch('01FK6TCJBDK41RJ766A4SBWDJ9')
+foo.aString = 'bar'
+foo.aBoolean = false
+await repository.save(foo)
+```
+
+Use the repository to create a new instance of an [Entity](../README.md#entity)
+before you save it:
+
+```typescript
+const foo = await repository.createEntity()
+foo.aString = 'bar'
+foo.aBoolean = false
+await repository.save(foo)
+```
+
+If you want to use the [search](Repository.md#search) method, you need to create an index
+first, and you need RediSearch or RedisJSON installed on your instance of Redis:
+
+```typescript
+await repository.createIndex()
+const entities = await repository.search()
+  .where('aString').eq('bar')
+  .and('aBoolean').is.false().returnAll()
+```
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Repository.md#constructor)
+
+### Methods
+
+- [createIndex](Repository.md#createindex)
+- [dropIndex](Repository.md#dropindex)
+- [expire](Repository.md#expire)
+- [expireAt](Repository.md#expireat)
+- [fetch](Repository.md#fetch)
+- [remove](Repository.md#remove)
+- [save](Repository.md#save)
+- [search](Repository.md#search)
+- [searchRaw](Repository.md#searchraw)
+
+## Constructors
+
+### constructor
+
+• **new Repository**(`schema`, `clientOrConnection`)
+
+Creates a new [Repository](Repository.md).
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `schema` | [`Schema`](Schema.md) | The schema defining that data in the repository. |
+| `clientOrConnection` | [`Client`](Client.md) \| [`RedisConnection`](../README.md#redisconnection) | - |
+
+#### Defined in
+
+[lib/repository/repository.ts:56](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L56)
+
+## Methods
+
+### createIndex
+
+▸ **createIndex**(): `Promise`<`void`\>
+
+Creates an index in Redis for use by the [search](Repository.md#search) method.
+Does not create a new index if the index hasn't changed. Requires that
+RediSearch and RedisJSON are installed on your instance of Redis.
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[lib/repository/repository.ts:71](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L71)
+
+___
+
+### dropIndex
+
+▸ **dropIndex**(): `Promise`<`void`\>
+
+Removes an existing index from Redis. Use this method if you want to swap out your index
+because your [Entity](../README.md#entity) has changed. Requires that RediSearch and RedisJSON are installed
+on your instance of Redis.
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[lib/repository/repository.ts:109](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L109)
+
+___
+
+### expire
+
+▸ **expire**(`id`, `ttlInSeconds`): `Promise`<`void`\>
+
+Set the time to live of the [Entity](../README.md#entity). If the [Entity](../README.md#entity) is not
+found, does nothing.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `id` | `string` | The ID of the [Entity](../README.md#entity) to set and expiration for. |
+| `ttlInSeconds` | `number` | The time to live in seconds. |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[lib/repository/repository.ts:242](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L242)
+
+▸ **expire**(`ids`, `ttlInSeconds`): `Promise`<`void`\>
+
+Set the time to live of the [Entities](../README.md#entity) in Redis with the given
+ids. If a particular [Entity](../README.md#entity) is not found, does nothing.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `ids` | `string`[] | The IDs of the [Entities](../README.md#entity) you wish to delete. |
+| `ttlInSeconds` | `number` | - |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[lib/repository/repository.ts:250](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L250)
+
+___
+
+### expireAt
+
+▸ **expireAt**(`id`, `expirationDate`): `Promise`<`void`\>
+
+Use Date object to set the [Entity](../README.md#entity)'s time to live. If the [Entity](../README.md#entity)
+is not found, does nothing.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `id` | `string` | The ID of the [Entity](../README.md#entity) to set an expiration date for. |
+| `expirationDate` | `Date` | The time the data should expire. |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[lib/repository/repository.ts:269](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L269)
+
+▸ **expireAt**(`ids`, `expirationDate`): `Promise`<`void`\>
+
+Use Date object to set the [Entities](../README.md#entity) in Redis with the given
+ids. If a particular [Entity](../README.md#entity) is not found, does nothing.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `ids` | `string`[] | The IDs of the [Entities](../README.md#entity) to set an expiration date for. |
+| `expirationDate` | `Date` | The time the data should expire. |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[lib/repository/repository.ts:278](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L278)
+
+___
+
+### fetch
+
+▸ **fetch**(`id`): `Promise`<[`Entity`](../README.md#entity)\>
+
+Read and return an [Entity](../README.md#entity) from Redis for the given id. If
+the [Entity](../README.md#entity) is not found, returns an empty [Entity](../README.md#entity).
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `id` | `string` | The ID of the [Entity](../README.md#entity) you seek. |
+
+#### Returns
+
+`Promise`<[`Entity`](../README.md#entity)\>
+
+The matching Entity.
+
+#### Defined in
+
+[lib/repository/repository.ts:171](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L171)
+
+▸ **fetch**(`...ids`): `Promise`<[`Entity`](../README.md#entity)[]\>
+
+Read and return the [Entities](../README.md#entity) from Redis with the given IDs. If
+a particular [Entity](../README.md#entity) is not found, returns that [Entity](../README.md#entity) as empty.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `...ids` | `string`[] | The IDs of the [Entities](../README.md#entity) you seek. |
+
+#### Returns
+
+`Promise`<[`Entity`](../README.md#entity)[]\>
+
+The matching Entities.
+
+#### Defined in
+
+[lib/repository/repository.ts:180](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L180)
+
+▸ **fetch**(`ids`): `Promise`<[`Entity`](../README.md#entity)[]\>
+
+Read and return the [Entities](../README.md#entity) from Redis with the given IDs. If
+a particular [Entity](../README.md#entity) is not found, returns that [Entity](../README.md#entity) as empty.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `ids` | `string`[] | The IDs of the [Entities](../README.md#entity) you seek. |
+
+#### Returns
+
+`Promise`<[`Entity`](../README.md#entity)[]\>
+
+The matching Entities.
+
+#### Defined in
+
+[lib/repository/repository.ts:189](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L189)
+
+___
+
+### remove
+
+▸ **remove**(`id`): `Promise`<`void`\>
+
+Remove an [Entity](../README.md#entity) from Redis for the given id. If the [Entity](../README.md#entity) is
+not found, does nothing.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `id` | `string` | The ID of the [Entity](../README.md#entity) you wish to delete. |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[lib/repository/repository.ts:205](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L205)
+
+▸ **remove**(`...ids`): `Promise`<`void`\>
+
+Remove the [Entities](../README.md#entity) from Redis for the given ids. If a
+particular [Entity](../README.md#entity) is not found, does nothing.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `...ids` | `string`[] | The IDs of the [Entities](../README.md#entity) you wish to delete. |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[lib/repository/repository.ts:213](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L213)
+
+▸ **remove**(`ids`): `Promise`<`void`\>
+
+Remove the [Entities](../README.md#entity) from Redis for the given ids. If a
+particular [Entity](../README.md#entity) is not found, does nothing.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `ids` | `string`[] | The IDs of the [Entities](../README.md#entity) you wish to delete. |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[lib/repository/repository.ts:221](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L221)
+
+___
+
+### save
+
+▸ **save**(`entity`): `Promise`<[`Entity`](../README.md#entity)\>
+
+Insert or update an [Entity](../README.md#entity) to Redis using its entityId property
+if present. If it's not, one is generated.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `entity` | [`Entity`](../README.md#entity) | The Entity to save. |
+
+#### Returns
+
+`Promise`<[`Entity`](../README.md#entity)\>
+
+A copy of the provided Entity with EntityId and EntityKeyName properties added.
+
+#### Defined in
+
+[lib/repository/repository.ts:134](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L134)
+
+▸ **save**(`id`, `entity`): `Promise`<[`Entity`](../README.md#entity)\>
+
+Insert or update the [Entity](../README.md#entity) to Redis using the provided entityId.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `id` | `string` | The id to save the Entity under. |
+| `entity` | [`Entity`](../README.md#entity) | The Entity to save. |
+
+#### Returns
+
+`Promise`<[`Entity`](../README.md#entity)\>
+
+A copy of the provided Entity with EntityId and EntityKeyName properties added.
+
+#### Defined in
+
+[lib/repository/repository.ts:143](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L143)
+
+___
+
+### search
+
+▸ **search**(): [`Search`](Search.md)
+
+Kicks off the process of building a query. Requires that RediSearch (and optionally
+RedisJSON) be installed on your instance of Redis.
+
+#### Returns
+
+[`Search`](Search.md)
+
+A [Search](Search.md) object.
+
+#### Defined in
+
+[lib/repository/repository.ts:301](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L301)
+
+___
+
+### searchRaw
+
+▸ **searchRaw**(`query`): [`RawSearch`](RawSearch.md)
+
+Creates a search that bypasses Redis OM and instead allows you to execute a raw
+RediSearch query. Requires that RediSearch (and optionally RedisJSON) be installed
+on your instance of Redis.
+
+Refer to https://redis.io/docs/stack/search/reference/query_syntax/ for details on
+RediSearch query syntax.
+
+**`Query`**
+
+The raw RediSearch query you want to rune.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+
+#### Returns
+
+[`RawSearch`](RawSearch.md)
+
+A [RawSearch](RawSearch.md) object.
+
+#### Defined in
+
+[lib/repository/repository.ts:316](https://github.com/redis/redis-om-node/blob/d8438f7/lib/repository/repository.ts#L316)