n8n-nodes-base/dist/node-definitions/nodes/n8n-nodes-base/dateTime/v1.ts

Base nodes of n8n

/**
 * Date & Time Node - Version 1
 * Allows you to manipulate date and time values
 */


export interface DateTimeV1Params {
  action?: 'calculate' | 'format' | Expression<string>;
/**
 * The value that should be converted
 * @displayOptions.show { action: ["format"] }
 */
    value?: string | Expression<string> | PlaceholderValue;
/**
 * Name of the property to which to write the converted date
 * @displayOptions.show { action: ["format"] }
 * @default data
 */
    dataPropertyName?: string | Expression<string> | PlaceholderValue;
/**
 * Whether a predefined format should be selected or custom format entered
 * @displayOptions.show { action: ["format"] }
 * @default false
 */
    custom?: boolean | Expression<boolean>;
/**
 * The format to convert the date to
 * @displayOptions.show { action: ["format"], custom: [true] }
 */
    toFormat?: string | Expression<string> | PlaceholderValue;
/**
 * Options
 * @displayOptions.show { action: ["format"] }
 * @default {}
 */
    options?: {
    /** In case the input format is not recognized you can provide the format
     */
    fromFormat?: string | Expression<string> | PlaceholderValue;
    /** The timezone to convert from. Choose from the list, or specify an ID using an &lt;a href="https://docs.n8n.io/code/expressions/"&gt;expression&lt;/a&gt;.
     * @default UTC
     */
    fromTimezone?: string | Expression<string>;
    /** The timezone to convert to. Choose from the list, or specify an ID using an &lt;a href="https://docs.n8n.io/code/expressions/"&gt;expression&lt;/a&gt;.
     * @default UTC
     */
    toTimezone?: string | Expression<string>;
  };
/**
 * Operation
 * @displayOptions.show { action: ["calculate"] }
 * @default add
 */
    operation?: 'add' | 'subtract';
/**
 * E.g. enter “10” then select “Days” if you want to add 10 days to Date Value.
 * @displayOptions.show { action: ["calculate"] }
 * @default 0
 */
    duration?: number | Expression<number>;
/**
 * Time unit for Duration parameter above
 * @displayOptions.show { action: ["calculate"] }
 * @default days
 */
    timeUnit?: 'quarters' | 'years' | 'months' | 'weeks' | 'days' | 'hours' | 'minutes' | 'seconds' | 'milliseconds' | Expression<string>;
}

interface DateTimeV1NodeBase {
  type: 'n8n-nodes-base.dateTime';
  version: 1;
}

export type DateTimeV1ParamsNode = DateTimeV1NodeBase & {
  config: NodeConfig<DateTimeV1Params>;
};

export type DateTimeV1Node = DateTimeV1ParamsNode;