source: trip-planner-front/node_modules/hdr-histogram-js/dist/HistogramBuilder.d.ts@ fa375fe

Last change on this file since fa375fe was 6a3a178, checked in by Ema <ema_spirova@…>, 3 years ago

initial commit

  • Property mode set to 100644
File size: 1.4 KB
Line 
1import Histogram, { BitBucketSize } from "./Histogram";
2export interface BuildRequest {
3 /**
4 * The size in bit of each count bucket
5 * Default value is 32
6 */
7 bitBucketSize?: BitBucketSize;
8 /**
9 * Control whether or not the histogram can auto-resize and auto-adjust it's
10 * highestTrackableValue
11 * Default value is true
12 */
13 autoResize?: boolean;
14 /**
15 * The lowest value that can be discerned (distinguished from 0) by the histogram.
16 * Must be a positive integer that is {@literal >=} 1. May be internally rounded
17 * down to nearest power of 2.
18 * Default value is 1
19 */
20 lowestDiscernibleValue?: number;
21 /**
22 * The highest value to be tracked by the histogram. Must be a positive
23 * integer that is {@literal >=} (2 * lowestDiscernibleValue).
24 * Default value is Number.MAX_SAFE_INTEGER
25 */
26 highestTrackableValue?: number;
27 /**
28 * The number of significant decimal digits to which the histogram will
29 * maintain value resolution and separation. Must be a non-negative
30 * integer between 0 and 5.
31 * Default value is 3
32 */
33 numberOfSignificantValueDigits?: 1 | 2 | 3 | 4 | 5;
34 /**
35 * Is WebAssembly used to speed up computations.
36 * Default value is false
37 */
38 useWebAssembly?: boolean;
39}
40export declare const defaultRequest: BuildRequest;
41export declare const build: (request?: BuildRequest) => Histogram;
Note: See TracBrowser for help on using the repository browser.