@solid-nestjs/rest-api/dist/classes/inputs/aggregate-field.input.d.ts

solid-nestjs Rest-API utilities

import { AggregateFunctionTypes } from '@solid-nestjs/common';
/**
 * REST API input type for defining aggregate field configurations in groupBy operations.
 *
 * @class AggregateFieldInput
 *
 * @example
 * ```json
 * {
 *   "field": "price",
 *   "function": "AVG",
 *   "alias": "avgPrice"
 * }
 * ```
 */
export declare class AggregateFieldInput {
    /**
     * The field name to apply the aggregate function to
     *
     * @example "price", "id", "supplier.name"
     */
    field: string;
    /**
     * The aggregate function to apply
     */
    function: AggregateFunctionTypes;
    /**
     * Optional alias for the aggregate result
     * If not provided, defaults to `${function}_${field}`
     */
    alias?: string;
}
//# sourceMappingURL=aggregate-field.input.d.ts.map