@zikeji/hypixel
Version:
With IntelliSense support & test coverage, this is an unopinionated async/await API wrapper for Hypixel's Public API. It is developed in TypeScript complete with documentation, typed interfaces for all API responses, built-in rate-limit handling, flexible
43 lines (42 loc) • 1.79 kB
TypeScript
import type { SkyBlockProfileMember } from "../types/Augmented/SkyBlock/ProfileMember";
import { NBTInventory } from "./TransformItemData";
/**
* Interface used in the {@link SkyBlockProfileMemberWithTransformedInventories} intersection to describe the intellisense for the inventory after being transformed.
*/
export interface SkyBlockProfileTransformedInventories {
inv_contents?: NBTInventory;
ender_chest_contents?: NBTInventory;
backpack_icons?: {
[key: string]: NBTInventory;
};
backpack_contents?: {
[key: string]: NBTInventory;
};
bag_contents?: {
fishing_bag?: NBTInventory;
potion_bag?: NBTInventory;
talisman_bag?: NBTInventory;
sacks_bag?: NBTInventory;
quiver?: NBTInventory;
};
inv_armor?: NBTInventory;
equipment_contents?: NBTInventory;
personal_vault_contents?: NBTInventory;
wardrobe_equipped_slots: number;
sacks_counts: {
[key: string]: number;
};
wardrobe_contents?: NBTInventory;
}
/**
* This type is a intersection type omitting the default inventory types and including the transformed inventory types.
*/
export type SkyBlockProfileMemberWithTransformedInventories = Omit<SkyBlockProfileMember, "inventory"> & {
inventory: SkyBlockProfileTransformedInventories;
};
/**
* This helper will loop over all the possible inventories on a profile and run the {@link transformSkyBlockItemData} helper on them, returning the member object with the transformed properties.
* @param member The profile member object that you want to transform the inventory data of.
* @category Helper
*/
export declare function transformSkyBlockProfileMemberInventories(member: SkyBlockProfileMember): Promise<SkyBlockProfileMemberWithTransformedInventories>;