communitybuilds-node/lib/index.d.ts

Node.js API for Genshin Impact communitiy builds spreadsheet

import { Artifact, Config, ElementResponse, GenshinElement, GenshinWeapons, Weapon } from './types/index.js';
export declare namespace CommunityBuilds {
    /**
     * Inits the package
     * @param key Google spreadsheet API key
     * @param config Caching config
     */
    function init(key: string, config?: Config): void;
    const pyro: () => Promise<ElementResponse>;
    const hydro: () => Promise<ElementResponse>;
    const anemo: () => Promise<ElementResponse>;
    const electro: () => import("fp-ts/lib/Task.js").Task<ElementResponse>;
    const dendro: () => Promise<ElementResponse>;
    const cryo: () => Promise<ElementResponse>;
    const geo: () => Promise<ElementResponse>;
    const getCharactersByElement: (element: GenshinElement) => Promise<ElementResponse>;
    /**
     * Retrieves all weapons of a given type
     * @deprecated Will be removed next release
     * @param type Weapon type
     */
    const getWeaponsByType: (type: GenshinWeapons) => Promise<Weapon[]>;
    /**
     * Retrieves all artifacts sets
     * @deprecated Will be removed next release
     * @param type Weapon type
     */
    const getArtifacts: () => Promise<Artifact[]>;
}
//# sourceMappingURL=index.d.ts.map