nodes/generated

Interface DateTimeV2NodeParameters

Source
interface DateTimeV2NodeParameters {
    customFormat?: string;
    date?: string;
    duration?: number;
    endDate?: string;
    format?:
        | "custom"
        | "X"
        | "x"
        | "MM/dd/yyyy"
        | "yyyy/MM/dd"
        | "MMMM dd yyyy"
        | "MM-dd-yyyy"
        | "yyyy-MM-dd";
    includeTime?: boolean;
    magnitude?: string;
    mode?: "roundDown"
    | "roundUp";
    operation?:
        | "addToDate"
        | "extractDate"
        | "formatDate"
        | "getCurrentDate"
        | "getTimeBetweenDates"
        | "roundDate"
        | "subtractFromDate";
    options?: | {
        includeInputFields?: boolean;
        timezone?: string;
    }
    | { includeInputFields?: boolean }
    | {
        fromFormat?: string;
        includeInputFields?: boolean;
        timezone?: boolean;
    }
    | { includeInputFields?: boolean; isoString?: boolean };
    outputFieldName?: string;
    part?:
        | "hour"
        | "day"
        | "week"
        | "month"
        | "year"
        | "minute"
        | "second";
    startDate?: string;
    timeUnit?: | "minutes"
    | "hours"
    | "days"
    | "weeks"
    | "months"
    | "quarters"
    | "years"
    | "seconds"
    | "milliseconds";
    to?: "month";
    toNearest?: | "hour"
    | "day"
    | "week"
    | "month"
    | "year"
    | "minute"
    | "second";
    units?: (
        | "hour"
        | "day"
        | "week"
        | "month"
        | "year"
        | "minute"
        | "second"
        | "millisecond"
    )[];
}

Properties§

Source§

readonly customFormat?: string

Source§

readonly date?: string

The date that you want to format

Source§

readonly duration?: number

The number of time units to add to the date

Source§

readonly endDate?: string

Source§

readonly format?:
    | "custom"
    | "X"
    | "x"
    | "MM/dd/yyyy"
    | "yyyy/MM/dd"
    | "MMMM dd yyyy"
    | "MM-dd-yyyy"
    | "yyyy-MM-dd"

The format to convert the date to Default: "MM/dd/yyyy"

Source§

readonly includeTime?: boolean

When deactivated, the time will be set to midnight Default: true

Source§

readonly magnitude?: string

The date that you want to change

Source§

readonly mode?: "roundDown" | "roundUp"

Default: "roundDown"

Source§

readonly operation?:
    | "addToDate"
    | "extractDate"
    | "formatDate"
    | "getCurrentDate"
    | "getTimeBetweenDates"
    | "roundDate"
    | "subtractFromDate"

Default: "getCurrentDate"

Source§

readonly options?:
    | {
        includeInputFields?: boolean;
        timezone?: string;
    }
    | { includeInputFields?: boolean }
    | {
        fromFormat?: string;
        includeInputFields?: boolean;
        timezone?: boolean;
    }
    | { includeInputFields?: boolean; isoString?: boolean }

Default: {}

Source§

readonly outputFieldName?: string

Name of the field to put the output in Default: "currentDate"

Source§

readonly part?:
    | "hour"
    | "day"
    | "week"
    | "month"
    | "year"
    | "minute"
    | "second"

Default: "month"

Source§

readonly startDate?: string

Source§

readonly timeUnit?:
    | "minutes"
    | "hours"
    | "days"
    | "weeks"
    | "months"
    | "quarters"
    | "years"
    | "seconds"
    | "milliseconds"

Time unit for Duration parameter below Default: "days"

Source§

readonly to?: "month"

Default: "month"

Source§

readonly toNearest?:
    | "hour"
    | "day"
    | "week"
    | "month"
    | "year"
    | "minute"
    | "second"

Default: "month"

Source§

readonly units?: (
    | "hour"
    | "day"
    | "week"
    | "month"
    | "year"
    | "minute"
    | "second"
    | "millisecond"
)[]

Default: ["day"]