Skip to main content

Type alias: PendingModelRelation<T, R>

PendingModelRelation<T, R>: object & PendingModelProp <RawModelRelation<T, R>>

Type declaration​

alias()​

alias: (alias) => PendingModelRelation<T, R>

Parameters​

• alias: string

Returns​

PendingModelRelation<T, R>

config()​

config: (config) => PendingModelRelation<T, R>

Parameters​

• config: string | string[] | ModelRelationConfig

Returns​

PendingModelRelation<T, R>

default()​

default: <NT>(value) => PendingModelRelation<NT, R>

Type parameters​

• NT extends T

Parameters​

• value: T | () => T

Returns​

PendingModelRelation<NT, R>

nullable​

nullable: unknown extends T ? never : () => PendingModelRelation<T | null, R>

readOnly()​

readOnly: <NR>(readOnly?) => PendingModelRelation<T, NR>

Type parameters​

• NR extends boolean = true

Parameters​

• readOnly?: NR

Returns​

PendingModelRelation<T, NR>

sync()​

sync: (alias) => PendingModelRelation<T, R>

Parameters​

• alias: boolean | ModelPropSync

Returns​

PendingModelRelation<T, R>

Type parameters​

• T

• R extends boolean

Source​

packages/core/src/model/props/builders/types.ts:49