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

Open Source Azur Lane Local Database

/**
 * Extended ship api functions
 * @packageDocumentation
 */
import { Ship } from '../../types/ship';
import API, { Language } from './api';
import { AzurAPI } from '../Client';
/**
 * Special ships class for extended functionality
 */
export declare class Ships extends API<Ship> {
    /**
     * Constructor
     * @param client An AzurAPI instance
     */
    constructor(client: AzurAPI);
    /**
     * Get by id
     * @param id String of number
     */
    id(id: string): Ship | undefined;
    /**
     * Get ship by name
     * @param name Ship name
     * @param languages Language to search
     */
    name(name: string, languages?: Language[]): Ship[] | [];
    /**
     * Get ship by hull
     * @param hull Hull name
     */
    hull(hull: string): Ship[] | [];
    /**
     * Get ship by nationality
     * @param nationality Nationality name
     */
    nationality(nationality: string): Ship[] | [];
    /**
     * Get ship using name in any language or id
     * @param query Ship name in any language or ship id
     */
    get(query: string): Ship | Ship[];
    /**
     * Get ship using everything
     * @param query basically anyting i guess
     */
    all(query: string): Ship[] | [];
    getShipIdByName(name: string, language?: string): string;
}