Class ObjectType<TValue, TRequired>

Object/JSONB type definition.

Type Parameters

TValue = unknown
The type of values in the record (default: unknown)
TRequired extends boolean = false
Whether the field is required

Hierarchy (View Summary)

Type<Record<string, TValue>, TRequired>
- ObjectType

Index

Constructors

constructor

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

Properties

`Protected`_required

_required: boolean

`Optional`defaultValue

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

hasDefault

hasDefault: boolean

isSensitive

isSensitive: boolean

isVirtual

isVirtual: boolean

options

options: Record<string, unknown>

validators

validators: ValidatorFunction<Record<string, TValue>>[]

Methods

default

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

getDefault

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

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

required

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

`Protected`runValidators

runValidators(value: Record, fieldName: string): void
Parameters
- value: Record
- 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<Record<string, TValue>, TRequired>
Validate the supplied value and return the normalized result.
Parameters
- value: unknown
- fieldName: string = 'field'
Returns TypeOutput<Record<string, TValue>, TRequired>
Overrides Type.validate
- Defined in dal/lib/type.ts:411

validator

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

Class ObjectType<TValue, TRequired>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ObjectType<TValue, TRequired>

Properties

Protected_required

OptionaldefaultValue

hasDefault

isSensitive

isVirtual

options

validators

Methods

default

Parameters

Returns this

getDefault

Returns TypeOutput<Record<string, TValue>, TRequired>

required

Type Parameters

Parameters

Returns ObjectType<TValue, T>

ProtectedrunValidators

Parameters

Returns void

sensitive

Parameters

Returns this

validate

Parameters

Returns TypeOutput<Record<string, TValue>, TRequired>

validator

Parameters

Returns this

Settings

On This Page

`Protected`_required

`Optional`defaultValue

`Protected`runValidators