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

Base nodes of n8n

/**
 * Summarize Node - Version 1
 * Sum, count, max, etc. across items
 */


export interface SummarizeV1Params {
  fieldsToSummarize?: {
    values?: Array<{
      /** How to combine the values of the field you want to summarize
       * @default count
       */
      aggregation?: 'append' | 'average' | 'concatenate' | 'count' | 'countUnique' | 'max' | 'min' | 'sum' | Expression<string>;
      /** The name of an input field that you want to summarize
       * @hint  Enter the field name as text
       * @displayOptions.hide { aggregation: ["average", "sum", "countUnique", "count", "max", "min"] }
       */
      field?: string | Expression<string> | PlaceholderValue;
      /** The name of an input field that you want to summarize. The field should contain numerical values; null, undefined, empty strings would be ignored.
       * @hint  Enter the field name as text
       * @displayOptions.show { aggregation: ["average", "sum"] }
       */
      field?: string | Expression<string> | PlaceholderValue;
      /** The name of an input field that you want to summarize; null, undefined, empty strings would be ignored
       * @hint  Enter the field name as text
       * @displayOptions.show { aggregation: ["countUnique", "count", "max", "min"] }
       */
      field?: string | Expression<string> | PlaceholderValue;
      /** Include Empty Values
       * @displayOptions.show { aggregation: ["append", "concatenate", "count", "countUnique"] }
       * @default false
       */
      includeEmpty?: boolean | Expression<boolean>;
      /** Separator
       * @hint What to insert between values
       * @displayOptions.show { aggregation: ["concatenate"] }
       * @default ,
       */
      separateBy?: ',' | ', ' | '\n' | '' | ' ' | 'other' | Expression<string>;
      /** Custom Separator
       * @displayOptions.show { aggregation: ["concatenate"], separateBy: ["other"] }
       */
      customSeparator?: string | Expression<string> | PlaceholderValue;
    }>;
  };
/**
 * The name of the input fields that you want to split the summary by
 * @hint Enter the name of the fields as text (separated by commas)
 * @displayOptions.hide { /options.outputFormat: ["singleItem"] }
 */
    fieldsToSplitBy?: string | Expression<string> | PlaceholderValue;
  options?: {
    /** Whether to continue if field to summarize can't be found in any items and return single empty item, otherwise an error would be thrown
     * @default false
     */
    continueIfFieldNotFound?: boolean | Expression<boolean>;
    /** Whether to disallow referencing child fields using `parent.child` in the field name
     * @default false
     */
    disableDotNotation?: boolean | Expression<boolean>;
    /** Output Format
     * @default separateItems
     */
    outputFormat?: 'separateItems' | 'singleItem' | Expression<string>;
    /** Ignore items without valid fields to group by
     * @default false
     */
    skipEmptySplitFields?: boolean | Expression<boolean>;
  };
}

interface SummarizeV1NodeBase {
  type: 'n8n-nodes-base.summarize';
  version: 1;
}

export type SummarizeV1ParamsNode = SummarizeV1NodeBase & {
  config: NodeConfig<SummarizeV1Params>;
};

export type SummarizeV1Node = SummarizeV1ParamsNode;