Class StringType<TRequired>

String type definition with common helpers.

Type Parameters

TRequired extends boolean = false

Hierarchy (View Summary)

Type<string, TRequired>
- StringType

Index

Constructors

Properties

_required defaultValue? enumValues hasDefault isSensitive isVirtual maxLength minLength options validators

Methods

default email enum getDefault max min required runValidators sensitive uuid validate validator

Constructors

constructor

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

Properties

`Protected`_required

_required: boolean

`Optional`defaultValue

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

enumValues

enumValues: string[]

hasDefault

hasDefault: boolean

isSensitive

isSensitive: boolean

isVirtual

isVirtual: boolean

maxLength

maxLength: number

minLength

minLength: number

options

options: Record<string, unknown>

validators

validators: ValidatorFunction<string>[]

Methods

default

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

email

email(): this
Returns this
- Defined in dal/lib/type.ts:153

enum

enum(values: string | string[]): this
Parameters
- values: string | string[]
Returns this
- Defined in dal/lib/type.ts:148

getDefault

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

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

max

max(length: number): this
Parameters
- length: number
Returns this
- Defined in dal/lib/type.ts:138

min

min(length: number): this
Parameters
- length: number
Returns this
- Defined in dal/lib/type.ts:143

required

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

`Protected`runValidators

runValidators(value: string, fieldName: string): void
Parameters
- value: string
- 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

uuid

uuid(_version?: number): this
Parameters
- _version: number = 4
Returns this
- Defined in dal/lib/type.ts:167

validate

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

validator

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