@react-native-ohos/flash-list
Version:
FlashList is a more performant FlatList replacement
58 lines • 2.56 kB
TypeScript
/**
* MIT License
*
* Copyright (C) 2024 Huawei Device Co., Ltd.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
import React from "react";
import FlashList from "../FlashList";
import { JSFPSResult } from "./JSFPSMonitor";
import { BlankAreaTrackerResult } from "./useBlankAreaTracker";
export interface BenchmarkParams {
startDelayInMs?: number;
/**
* Can be used to increase or decrease speed of scrolling
*/
speedMultiplier?: number;
/**
* Specify the number of times benchmark should repeat itself
*/
repeatCount?: number;
/**
* When set to true, cumulative blank area will include sum of negative blank area values
* Blank area is negative when list is able to draw faster than the scroll speed.
*/
sumNegativeBlankAreaValues?: boolean;
}
export interface BenchmarkResult {
js?: JSFPSResult;
interrupted: boolean;
suggestions: string[];
blankArea?: BlankAreaTrackerResult;
formattedString?: string;
}
/**
* Runs the benchmark on FlashList.
* Response object has a formatted string that can be printed to the console or shown as an alert.
* Result is posted to the callback method passed to the hook.
*/
export declare function useBenchmark(flashListRef: React.RefObject<FlashList<any>>, callback: (benchmarkResult: BenchmarkResult) => void, params?: BenchmarkParams): ((event: import("..").BlankAreaEvent) => void)[];
export declare function getFormattedString(res: BenchmarkResult): string;
//# sourceMappingURL=useBenchmark.d.ts.map