starrail-manager
Version:
The StarRail Manager is a Node.js wrapper for the MiHoMo API and StarRail Data used in Honkai: StarRail.\ **This is not an official Honkai: StarRail project.**
36 lines (35 loc) • 1.02 kB
TypeScript
import { charData } from "../types//starrail";
import { createCanvas } from "canvas";
interface ClientOptions {
lang?: string;
}
/**
* get data or create Build Card from MiHoMo API
*/
export declare class Client {
private lang;
constructor(options?: ClientOptions);
/**
* get user and character data from MiHoMo API
* @param uid - user id
* @returns user and character data in json
*/
getUserData(uid: number): Promise<any>;
/**
* get character data with scores
* @param uid - user id
* @param index - character index(0 ~ 7)
* @returns character data with score in json
*/
getCharData(uid: number, index: number): Promise<charData | null>;
/**
* create character build card
* @param uid - user id
* @param index character index(0 ~ 7)
* @returns build card in canvas
*
* @remarks only japanese
*/
createBuildCard(uid: number, index: number): Promise<ReturnType<typeof createCanvas> | null>;
}
export {};