📦 facebook / react-native

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133/**
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @flow strict
 * @format
 */

declare module 'tinybench' {
  declare export class Task extends EventTarget {
    name: string;
    result: void | Readonly<TaskResult>;
    runs: number;

    reset(): void;
    run(): Promise<Task>;
    runSync(): Task;
    warmup(): Promise<void>;
  }

  export type Hook = (
    task: Task,
    mode: 'run' | 'warmup',
  ) => Promise<void> | void;

  export type BenchOptions = {
    iterations?: number,
    name?: string,
    now?: () => number,
    setup?: Hook,
    signal?: AbortSignal,
    teardown?: Hook,
    throws?: boolean,
    time?: number,
    warmup?: boolean,
    warmupIterations?: number,
    warmupTime?: number,
  };

  export interface Statistics {
    aad: void | number;
    critical: number;
    df: number;
    mad: void | number;
    max: number;
    mean: number;
    min: number;
    moe: number;
    p50: void | number;
    p75: void | number;
    p99: void | number;
    p995: void | number;
    p999: void | number;
    rme: number;
    samples: number[];
    sd: number;
    sem: number;
    variance: number;
  }

  export interface TaskResult {
    critical: number;
    df: number;
    error?: Error;
    hz: number;
    latency: Statistics;
    max: number;
    mean: number;
    min: number;
    moe: number;
    p75: number;
    p99: number;
    p995: number;
    p999: number;
    period: number;
    rme: number;
    samples: number[];
    sd: number;
    sem: number;
    throughput: Statistics;
    totalTime: number;
    variance: number;
  }

  export type FnOptions = {
    afterAll?: (this: Task) => void | Promise<void>,
    afterEach?: (this: Task) => void | Promise<void>,
    beforeAll?: (this: Task) => void | Promise<void>,
    beforeEach?: (this: Task) => void | Promise<void>,
  };

  // This is defined as an interface in tinybench but we define it as an object
  // to catch problems like `overriddenDuration` being misspelled.
  export type FnReturnedObject = {
    overriddenDuration?: number,
  };

  // This type is defined as returning `unknown` instead of `void` in tinybench,
  // but we type it this way to avoid mistakes (we can make breaking changes
  // in our definition that they can't).
  export type Fn = () =>
    | Promise<void | FnReturnedObject>
    | void
    | FnReturnedObject;

  declare export class Bench extends EventTarget {
    concurrency: null | 'task' | 'bench';
    name?: string;
    opts: Readonly<BenchOptions>;
    threshold: number;

    constructor(options?: BenchOptions): this;

    // $FlowExpectedError[unsafe-getters-setters]
    get results(): Array<Readonly<TaskResult>>;

    // $FlowExpectedError[unsafe-getters-setters]
    get tasks(): Array<Task>;

    add(name: string, fn: Fn, fnOpts?: FnOptions): this;
    getTask(name: string): void | Task;
    remove(name: string): this;
    reset(): void;
    run(): Promise<Array<Task>>;
    runSync(): Array<Task>;
    table(
      convert?: (task: Task) => Record<string, void | string | number>,
    ): void | Array<Record<string, void | string | number>>;
  }
}