@azurapi/azurapi/build/core/api/api_equipment.d.ts

Open Source Azur Lane Local Database

/**
 * Extended equipment api functions
 * @packageDocumentation
 */
import { Equipment } from '../../types/equipment';
import API, { Language } from './api';
import { AzurAPI } from '../Client';
/**
 * Special equipments class for extended functionality
 */
export declare class Equipments extends API<Equipment> {
    /**
     * Constructor
     * @param client An AzurAPI instance
     */
    constructor(client: AzurAPI);
    /**
     * Get by id
     * @param id String of number
     */
    id(id: string): Equipment | undefined;
    /**
     * Get equipment by name
     * @param name Equipment name
     * @param languages Language to search
     */
    name(name: string, languages?: Language[]): Equipment[] | [];
    /**
     * Lists the equipments by category
     * @param category name of the category you want to search for
     */
    category(category: string): Equipment[] | [];
    /**
     * Lists the equipments by nationality
     * @param nationality naitionality name of the equipments you want to search for
     */
    nationality(nationality: string): Equipment[] | [];
    /**
     * Get equipment using name in any language or id
     * @param query Equipment name in any language or equipment id
     */
    get(query: string): Equipment | Equipment[];
    /**
     * Get equipment using everything
     * @param query basically anyting i guess
     */
    all(query: string): Equipment[] | [];
}