Class: Schema<T>

Defined in: ridb_core.d.ts:545

Represents a schema, including its definition and related methods. You may be trying to build a storage, in any other can u won't need access tho this class. Check this example

typescript
1
2
3
4
5
class MyStorage extends <T extends SchemaTypeRecord> extends BaseStorage<T> {
 example() {
   const schema: Schema<any> = this.getSchema("mySchema")
 }
}

You alwayswill have access to getSchema through the Storage class.

Type Parameters

T

T extends SchemaType

The schema type.

Constructors

Constructor

typescript
1
new Schema<T>(): Schema<T>

Returns

Schema<T>

Properties

encrypted?

typescript
1
readonly optional encrypted: Extract<keyof T, string>[]

Defined in: ridb_core.d.ts:586

An optional array of encrypted fields.

indexes?

typescript
1
readonly optional indexes: Extract<keyof T, string>[]

Defined in: ridb_core.d.ts:581

An optional array of indexes.

primaryKey

typescript
1
readonly primaryKey: string

Defined in: ridb_core.d.ts:568

The primary key of the schema.

properties

typescript
1
readonly properties: { [K in string | number | symbol as T["properties"][K]["required"] extends false | (T["properties"][K]["default"] extends undefined ? true : false) ? K : never]?: T["properties"][K] } & { [K in string | number | symbol as T["properties"][K]["required"] extends false ? never : K]: T["properties"][K] }

Defined in: ridb_core.d.ts:591

The properties defined in the schema.

schema

typescript
1
schema: Schema<T>

Defined in: ridb_core.d.ts:549

The schema definition.

type

typescript
1
readonly type: SchemaFieldType

Defined in: ridb_core.d.ts:573

The type of the schema.

version

typescript
1
readonly version: number

Defined in: ridb_core.d.ts:563

The version of the schema.

Methods

toJSON()

typescript
1
toJSON(): SchemaType

Defined in: ridb_core.d.ts:601

Converts the schema to a JSON representation.

Returns

SchemaType

The JSON representation of the schema.

validate()

typescript
1
validate(document): boolean

Defined in: ridb_core.d.ts:603

Parameters

document

Doc<Schema<T>>

Returns

boolean

create()

typescript
1
static create<TS>(definition): Schema<TS>

Defined in: ridb_core.d.ts:558

Creates a new Schema instance from the provided definition.

Type Parameters

TS

TS extends SchemaType

The schema type.

Parameters

definition

TS

Returns

Schema<TS>

The created Schema instance.