osu-api-extended/dist/tools/net-pp.d.ts

Advanced osu! api wrapper cover all V2 and V1 endpoints, and provide useful tools

import type { IError } from "../types";
import { scores_list_user_user_best_response } from "../types/v2/scores_list_user_best";
type Response = {
    pp: number;
    totalNow: number;
    totalBefore: number;
} & IError;
/**
 * Calculate how much raw pp you would gain from a play
 *
 *  
 *
 * ### Parameters
 * - `scores` - Plays pp or Array of scores
 * - `pp` - Amount of play pp
 *
 *  
 *
 * ### Usage Example
 * ```js
 * const { tools } = require('osu-api-extended');
 *
 * function main() {
 *   try {
 *     const plays = [1000, 900, 800, 700];
 *     const scores = [{ id: 123, pp: 1000 }, { id: 123, pp: 555 }, { id: 123, pp: 234 }, { id: 123, pp: 100 }];
 *     const result = tools.calculate_net_pp(plays, 400);
 *     // or
 *     const result = tools.calculate_net_pp(scores, 400);
 *     if (result.error != null) {
 *       console.log(result.error);
 *       return;
 *     };
 *
 *
 *     console.log(result);
 *   } catch (error) {
 *     console.log(error);
 *   };
 * };
 *
 * main();
 * ```
 */
export declare const calculate_net_pp: (scores: scores_list_user_user_best_response[] | number[], pp: number) => Response;
export {};