Skip to content
approval@dev

API

FieldDef

@rivyn/db


@rivyn/db / FieldDef

Interface: FieldDef

Properties

default?

optional default?: unknown


enum?

optional enum?: readonly unknown[]


fields?

optional fields?: SchemaDefinition


index?

optional index?: boolean


match?

optional match?: RegExp


max?

optional max?: number


maxLength?

optional maxLength?: number


min?

optional min?: number


minLength?

optional minLength?: number


nullable?

optional nullable?: boolean


of?

optional of?: FieldDef | FieldType


required?

optional required?: boolean


type

type: FieldType


unique?

optional unique?: boolean


validate?

optional validate?: (value) => string | boolean

Parameters

value

unknown

Returns

string | boolean