foundation-filters.percentagefilter
Home > @genesislcap/foundation-filters > percentageFilter
percentageFilter() function
Percentage client filter function.
Signature:
export declare function percentageFilter(percent: number, random?: number): boolean;
Parameters
Parameter | Type | Description |
---|---|---|
percent | number | The percent of the time to pass, a numeric value between 0 and 1. |
random | number | (Optional) Math.random() generated floating-point. |
Returns:
boolean
Remarks
This will return true a certain percentage of the time.