isAllTimeDashboardDateFilterWithEmptyValueHandling()

Home > @gooddata/sdk-model > isAllTimeDashboardDateFilterWithEmptyValueHandling

isAllTimeDashboardDateFilterWithEmptyValueHandling() function

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Type-guard testing whether the provided object is an All time dashboard date filter with emptyValueHandling explicitly defined.

Signature:

export declare function isAllTimeDashboardDateFilterWithEmptyValueHandling(obj: unknown): obj is IDashboardDateFilter & {
    dateFilter: {
        emptyValueHandling: EmptyValues;
    };
};

Parameters

Parameter	Type	Description
obj	unknown

Returns:

obj is IDashboardDateFilter & { dateFilter: { emptyValueHandling: EmptyValues; }; }

Remarks

This is useful to distinguish between: - a "noop" All time filter (implicit default, no additional config), and - an All time filter that carries extra configuration (e.g. empty date values handling).