reveal-sdk-node
Version:
RevealBI Node.js SDK
25 lines (24 loc) • 1.12 kB
TypeScript
import { RVPeriodRelation } from "./ts-sdk/rvPeriodRelation";
import { RVPeriodType } from "./ts-sdk/rvPeriodType";
/**
* A class that represents a date rule for a filter.
*/
declare class RVDateRule {
periodRelation: RVPeriodRelation;
periodType: RVPeriodType;
count: number;
/**
* Create a date rule with the specified period relation and period type.
* @param periodRelation - Relation of the rule's time period to the current date
* @param periodType - Type of time period used as time unit for the rule's period
*/
constructor(periodRelation: RVPeriodRelation, periodType: RVPeriodType);
/**
* Create a date rule with the specified period relation, count and period type.
* @param periodRelation - Relation of the rule's time period to the current date
* @param periodCount - Amount of periods to be counted
* @param periodType - Type of time period used as time unit for the rule's period
*/
constructor(periodRelation: RVPeriodRelation, periodCount: number, periodType: RVPeriodType);
}
export { RVDateRule };