Class Schema<TSchema>

Represents a schema for JSON Documents stored in Redis.

Type Parameters

TSchema extends StandardSchemaV1

Index

Constructors

Accessors

createIndexOptions prefix searchSchema

Methods

createRepository validate

Constructors

constructor

new Schema<TSchema extends StandardSchemaV1<unknown, unknown>>(
    prefix: string,
    schema: TSchema,
    searchSchema: RediSearchSchema,
    options?: SanitizedCreateIndexOptions,
): Schema<TSchema>
Creates a new schema for JSON Documents stored in Redis.
Type Parameters
- TSchema extends StandardSchemaV1<unknown, unknown>
Parameters
- prefix: string
  the prefix to use for Redis keys
- schema: TSchema
  the TypeScript schema definition for the JSON Documents
- searchSchema: RediSearchSchema
  the RediSearch schema definition for the JSON Documents
- Optionaloptions: SanitizedCreateIndexOptions
  additional options for creating the index
Returns Schema<TSchema>
- Defined in src/models/schema.ts:81

Accessors

createIndexOptions

get createIndexOptions(): Readonly<SanitizedCreateIndexOptions> | undefined
Returns Readonly<SanitizedCreateIndexOptions> | undefined
- Defined in src/models/schema.ts:65

prefix

get prefix(): string
Returns string
- Defined in src/models/schema.ts:61

searchSchema

get searchSchema(): Readonly<RediSearchSchema>
Returns Readonly<RediSearchSchema>
- Defined in src/models/schema.ts:69

Methods

createRepository

createRepository<
    M extends RedisModules,
    F extends RedisFunctions,
    S extends RedisScripts,
    R extends RespVersions,
    T extends TypeMapping,
>(
    client:
        | RedisClientType<M, F, S, R, T>
        | RedisClientPoolType<M, F, S, R, T>,
    guard?: OperationGuard,
): Repository<TSchema>
Creates a new repository instance for the schema.
Type Parameters
- M extends RedisModules
- F extends RedisFunctions
- S extends RedisScripts
- R extends RespVersions
- T extends TypeMapping
Parameters
- client: RedisClientType<M, F, S, R, T> | RedisClientPoolType<M, F, S, R, T>
  the Redis client to use for the repository
- Optionalguard: OperationGuard
  an optional operation guard to control Redis operations
Returns Repository<TSchema>
a new repository instance for the schema
- Defined in src/models/schema.ts:112

validate

validate(value: unknown, options?: Options): Promise<Result<unknown>>
Validates a value against the schema.
Parameters
- value: unknown
  the value to validate against the schema
- Optionaloptions: Options
  optional validation options
Returns Promise<Result<unknown>>
the result of the validation, including any errors if validation fails
- Defined in src/models/schema.ts:99