Class VirtualType<TValue, TRequired>

Virtual/computed field type definition.

Type Parameters

TValue = unknown
TRequired extends boolean = false

Hierarchy (View Summary)

Type<TValue, TRequired>
- VirtualType

Index

Constructors

Properties

_required defaultValue? hasDefault isSensitive isVirtual options validators

Methods

default getDefault required returns runValidators sensitive validate validator

Constructors

constructor

new VirtualType<TValue = unknown, TRequired extends boolean = false>(
options?: Record<string, unknown>,
): VirtualType<TValue, TRequired>
Type Parameters
- TValue = unknown
- TRequired extends boolean = false
Parameters
- options: Record<string, unknown> = {}
Returns VirtualType<TValue, TRequired>
Overrides Type.constructor
- Defined in dal/lib/type.ts:439

Properties

`Protected`_required

_required: boolean

`Optional`defaultValue

defaultValue?:
| TypeOutput<TValue, TRequired>
| () => TypeOutput<TValue, TRequired>

hasDefault

hasDefault: boolean

isSensitive

isSensitive: boolean

isVirtual

isVirtual: boolean

options

options: Record<string, unknown>

validators

validators: ValidatorFunction<TValue>[]

Methods

default

default(
    value:
        | TypeOutput<TValue, TRequired>
        | () => TypeOutput<TValue, TRequired>,
): this
Configure a default value (or factory) for the field.
Parameters
- value: TypeOutput<TValue, TRequired> | () => TypeOutput<TValue, TRequired>
Returns this
Inherited from Type.default
- Defined in dal/lib/type.ts:60

getDefault

getDefault(): TypeOutput<TValue, TRequired>
Resolve a configured default for the field, if any.

Returns TypeOutput<TValue, TRequired>
Inherited from Type.getDefault
- Defined in dal/lib/type.ts:110

required

required<T extends boolean = true>(isRequired?: T): VirtualType<TValue, T>
Mark the field as required or optional.
Type Parameters
- T extends boolean = true
Parameters
- isRequired: T = ...
Returns VirtualType<TValue, T>
Overrides Type.required
- Defined in dal/lib/type.ts:444

returns

returns<TNewValue>(): VirtualType<TNewValue, TRequired>
Type Parameters
- TNewValue
Returns VirtualType<TNewValue, TRequired>
- Defined in dal/lib/type.ts:449

`Protected`runValidators

runValidators(value: TValue, fieldName: string): void
Parameters
- value: TValue
- fieldName: string
Returns void
Inherited from Type.runValidators
- Defined in dal/lib/type.ts:74

sensitive

sensitive(isSensitive?: boolean): this
Flag the field as sensitive so joins/exposures can omit it by default.
Parameters
- isSensitive: boolean = true
Returns this
Inherited from Type.sensitive
- Defined in dal/lib/type.ts:69

validate

validate(value: unknown, fieldName?: string): TypeOutput<TValue, TRequired>
Validate the supplied value and return the normalized result.
Parameters
- value: unknown
- fieldName: string = 'field'
Returns TypeOutput<TValue, TRequired>
Overrides Type.validate
- Defined in dal/lib/type.ts:453

validator

validator(validator: ValidatorFunction<TValue>): this
Add a validator function that will receive the normalized value.
Parameters
- validator: ValidatorFunction<TValue>
Returns this
Inherited from Type.validator
- Defined in dal/lib/type.ts:42