apisearch/src/Result/ResultAggregations.ts

Javascript client for Apisearch.

import {ResultAggregation} from "./ResultAggregation";

/**
 * ResultAggregation class
 */
export class ResultAggregations {

    private aggregations: any = {};
    private totalElements: number;

    /**
     * Constructor
     *
     * @param totalElements
     */
    constructor(totalElements: number) {
        this.totalElements = totalElements;
    }

    /**
     * Add aggregation
     *
     * @param name
     * @param aggregation
     */
    public addAggregation(
        name: string,
        aggregation: ResultAggregation,
    ) {
        this.aggregations[name] = aggregation;
    }

    /**
     * Get aggregations
     *
     * @returns {{}}
     */
    public getAggregations(): any {
        return this.aggregations;
    }

    /**
     * Get aggregation
     *
     * @param name
     *
     * @returns {Aggregation|null}
     */
    public getAggregation(name: string) {
        return this.aggregations[name] instanceof ResultAggregation
            ? this.aggregations[name]
            : null;
    }

    /**
     * Has not empty aggregation
     *
     * @param name
     *
     * @returns {boolean}
     */
    public hasNotEmptyAggregation(name: string): boolean {
        const aggregation = this.getAggregation(name);
        return (aggregation instanceof ResultAggregation) &&
            (!aggregation.isEmpty());
    }

    /**
     * Get total elements
     *
     * @return {number}
     */
    public getTotalElements(): number {
        return this.totalElements;
    }

    /**
     * To array
     *
     * @return {{total_elements?: number, aggregations?: {}}}
     */
    public toArray(): {total_elements?: number, aggregations?: {}} {
        const aggregationCollection = {};
        for (const i in this.aggregations) {
            aggregationCollection[i] = this.aggregations[i].toArray();
        }

        const array: {total_elements?: number, aggregations?: {}} = {};

        if (this.totalElements > 0) {
            array.total_elements = this.totalElements;
        }

        if (Object.keys(aggregationCollection).length > 0) {
            array.aggregations = aggregationCollection;
        }

        return array;
    }

    /**
     * Create from array
     *
     * @param array
     *
     * @return {ResultAggregations}
     */
    public static createFromArray(array: any) {
        const aggregations = new ResultAggregations(
            typeof array.total_elements === "number"
                ? array.total_elements
                : 0,
        );

        if (typeof array.aggregations === typeof {}) {
            for (const i in array.aggregations) {
                aggregations.addAggregation(
                    i,
                    ResultAggregation.createFromArray(array.aggregations[i]),
                );
            }
        }

        return aggregations;
    }
}