Function FutureDayjs

  • FutureDayjs(
        options?: {
            allow_invalid?: boolean;
            granularity?: OpUnitType;
            inclusive?: boolean;
        } & ValidationOptions,
    ): PropertyDecorator

    Checks if the given value is a valid Dayjs object in the future.

    Beware that the behaviour of this check depends on the current time and can thus be difficult to test. In particular, as time goes by the property can become invalid without ever changing its value.

    Example

    // Ensure the value is in the future.
    @FutureDayjs()
    scheduledFor: Dayjs

    Parameters

    • Optionaloptions: { allow_invalid?: boolean; granularity?: OpUnitType; inclusive?: boolean } & ValidationOptions

      Accepts the following options (in addition to generic class-validator options):

      • allow_invalid: boolean = false If true, allow the Dayjs object to be invalid (see isValid()).
      • inclusive: boolean = false If true, allow the current date as well.
      • granularity: string = 'milliseconds' Defines the granularity, e.g. "day" to ignore hours, minutes, seconds and milliseconds.

    Returns PropertyDecorator

Settings

Member Visibility

On This Page

Example