isAllTimeDateFilterWithEmptyValueHandling()

Home > @gooddata/sdk-model > isAllTimeDateFilterWithEmptyValueHandling

isAllTimeDateFilterWithEmptyValueHandling() function

Type guard checking whether the provided object is an all time date filter with emptyValueHandling defined.

Signature:

export declare function isAllTimeDateFilterWithEmptyValueHandling(obj: unknown): obj is IRelativeDateFilter & {
    relativeDateFilter: IRelativeDateFilterAllTimeBody & {
        emptyValueHandling: EmptyValues;
    };
};

Parameters

Parameter	Type	Description
obj	unknown

Returns:

obj is IRelativeDateFilter & { relativeDateFilter: IRelativeDateFilterAllTimeBody & { emptyValueHandling: EmptyValues; }; }

Remarks

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