ryuu.js/dist/models/interfaces/filter.d.ts

Ryuu JavaScript Utility Library

/**
 * Referenced from com/domo/api/content/client/views/model/Operator.java
 */
export declare enum FilterOperatorsString {
    IN = "IN",
    NOT_IN = "NOT_IN",
    CONTAINS = "CONTAINS",
    NOT_CONTAINS = "NOT_CONTAINS",
    STARTS_WITH = "STARTS_WITH",
    NOT_STARTS_WITH = "NOT_STARTS_WITH",
    ENDS_WITH = "ENDS_WITH",
    NOT_ENDS_WITH = "NOT_ENDS_WITH"
}
export declare enum FilterOperatorsNumeric {
    GREATER_THAN = "GREATER_THAN",
    GREAT_THAN_EQUALS_TO = "GREAT_THAN_EQUALS_TO",
    LESS_THAN = "LESS_THAN",
    LESS_THAN_EQUALS_TO = "LESS_THAN_EQUALS_TO",
    BETWEEN = "BETWEEN",
    EQUALS = "EQUALS",
    NOT_EQUALS = "NOT_EQUALS"
}
export declare enum FilterDataTypes {
    NUMERIC = "NUMERIC",
    DATE = "DATE",
    DATETIME = "DATETIME",
    STRING = "STRING"
}
/**
 * Base interface for all filters.
 */
interface BaseFilter<T, O, D> {
    /** The column to filter on. */
    column: string;
    /** The operator to use. */
    operator: O;
    /** The values to filter by. */
    values: T[];
    /** The data type of the column. */
    dataType: D;
}
/**
 * Filter type for Domo data queries.
 */
export type Filter = BaseFilter<Date, FilterOperatorsNumeric, FilterDataTypes.DATE | FilterDataTypes.DATETIME> | BaseFilter<number, FilterOperatorsNumeric, FilterDataTypes.NUMERIC> | BaseFilter<string, FilterOperatorsString, FilterDataTypes.STRING>;
export {};