Interface ModelOptions

Schema to design data models

interface ModelOptions {
    description?: string;
    encrypt?: boolean;
    extends?: [ModelName, ...ModelName[]];
    indexes?: PropertyName1[][];
    internal?: boolean;
    name?: ModelName;
    properties?: { [k: string]: PropertyOptions & { [k: string]: unknown } };
    readonly?: boolean;
    relations?: { [k: string]: RelationOptions };
    type?: ModelType;
    uniques?: PropertyName1[][];
}

Index

Properties

description? encrypt? extends? indexes? internal? name? properties? readonly? relations? type? uniques?

Properties

`Optional`description

description?: string

`Optional`encrypt

encrypt?: boolean

`Optional`extends

extends?: [ModelName, ...ModelName[]]

Min Items

1

`Optional`indexes

indexes?: PropertyName1[][]

`Optional`internal

internal?: boolean

`Optional`name

name?: ModelName

`Optional`properties

properties?: { [k: string]: PropertyOptions & { [k: string]: unknown } }

Type Declaration

[k: string]: PropertyOptions & { [k: string]: unknown }
This interface was referenced by undefined's JSON-Schema definition via the patternProperty ".*".

`Optional`readonly

readonly?: boolean

`Optional`relations

relations?: { [k: string]: RelationOptions }

`Optional`type

type?: ModelType

`Optional`uniques

uniques?: PropertyName1[][]