swapi-ts/dist/SWApi.d.ts

a ts wrapper for swapi.dev

export interface IFilm {
    characters: string[] | IPeople[];
    created: Date;
    director: string;
    edited: Date;
    episode_id: string;
    opening_crawl: string;
    planets: string[] | IPlanet[];
    producer: string;
    release_date: Date;
    species: string[] | ISpecie[];
    starships: string[] | IStarship[];
    title: string;
    url: string;
    vehicles: string[] | IVehicle[];
}
export interface IPeople {
    birth_year: string;
    eye_color: string;
    films: string[] | IFilm[];
    gender: string;
    hair_color: string;
    height: string;
    homeworld: string | IPlanet;
    mass: string;
    name: string;
    skin_color: string;
    created: Date;
    edited: Date;
    species: string[] | ISpecie[];
    starships: string[] | IStarship[];
    url: string;
    vehicles: string[] | IVehicle[];
}
export interface IPlanet {
    climate: string;
    created: Date;
    diameter: string;
    edited: Date;
    films: string[] | IFilm[];
    gravity: string;
    name: string;
    orbital_period: string;
    population: string;
    residents: string[] | IPeople[];
    rotation_period: string;
    surface_water: string;
    terrain: string;
    url: string;
}
export interface ISpecie {
    average_height: string;
    average_lifespan: string;
    classification: string;
    created: Date;
    designation: string;
    edited: Date;
    eye_colors: string;
    hair_colors: string;
    homeworld: string | IPlanet;
    language: string;
    name: string;
    people: string[] | IPeople[];
    films: string[] | IFilm[];
    skin_colors: string;
    url: string;
}
export interface IStarship {
    MGLT: string;
    cargo_capacity: string;
    consumables: string;
    cost_in_credits: string;
    created: Date;
    crew: string;
    edited: Date;
    hyperdrive_rating: string;
    length: string;
    manufacturer: string;
    max_atmosphering_speed: string;
    model: string;
    name: string;
    passengers: string;
    films: string[] | IFilm[];
    pilots: string[] | IPeople[];
    starship_class: string;
    url: string;
}
export interface IVehicle {
    cargo_capacity: string;
    consumables: string;
    cost_in_credits: string;
    created: Date;
    crew: string;
    edited: Date;
    length: string;
    manufacturer: string;
    max_atmosphering_speed: string;
    model: string;
    name: string;
    passengers: string;
    pilots: string[] | IPeople[];
    films: string[] | IFilm[];
    url: string;
    vehicle_class: string;
}
export declare enum ResourcesType {
    Films = "films",
    People = "people",
    Planets = "planets",
    Species = "species",
    Starships = "starships",
    Vehicles = "vehicles"
}
declare class Resource<S> {
    value: S;
    constructor(value: S);
    populate(path: string): Promise<this>;
    private populateSingle;
    private populateRec;
}
export declare const Films: {
    new (unparsedResources: IFilm[]): {
        resources: Resource<IFilm>[];
        populateAll(path: string): Promise<any>;
    };
    root: string;
    getPage(page?: number, search?: string | undefined): Promise<any>;
    find(predicate?: ((single: IFilm) => boolean) | undefined): Promise<{
        resources: Resource<IFilm>[];
        populateAll(path: string): Promise<any>;
    }>;
    findBySearch(predicate: string[]): Promise<{
        resources: Resource<IFilm>[];
        populateAll(path: string): Promise<any>;
    }>;
};
export declare const People: {
    new (unparsedResources: IPeople[]): {
        resources: Resource<IPeople>[];
        populateAll(path: string): Promise<any>;
    };
    root: string;
    getPage(page?: number, search?: string | undefined): Promise<any>;
    find(predicate?: ((single: IPeople) => boolean) | undefined): Promise<{
        resources: Resource<IPeople>[];
        populateAll(path: string): Promise<any>;
    }>;
    findBySearch(predicate: string[]): Promise<{
        resources: Resource<IPeople>[];
        populateAll(path: string): Promise<any>;
    }>;
};
export declare const Planets: {
    new (unparsedResources: IPlanet[]): {
        resources: Resource<IPlanet>[];
        populateAll(path: string): Promise<any>;
    };
    root: string;
    getPage(page?: number, search?: string | undefined): Promise<any>;
    find(predicate?: ((single: IPlanet) => boolean) | undefined): Promise<{
        resources: Resource<IPlanet>[];
        populateAll(path: string): Promise<any>;
    }>;
    findBySearch(predicate: string[]): Promise<{
        resources: Resource<IPlanet>[];
        populateAll(path: string): Promise<any>;
    }>;
};
export declare const Species: {
    new (unparsedResources: ISpecie[]): {
        resources: Resource<ISpecie>[];
        populateAll(path: string): Promise<any>;
    };
    root: string;
    getPage(page?: number, search?: string | undefined): Promise<any>;
    find(predicate?: ((single: ISpecie) => boolean) | undefined): Promise<{
        resources: Resource<ISpecie>[];
        populateAll(path: string): Promise<any>;
    }>;
    findBySearch(predicate: string[]): Promise<{
        resources: Resource<ISpecie>[];
        populateAll(path: string): Promise<any>;
    }>;
};
export declare const Starships: {
    new (unparsedResources: IStarship[]): {
        resources: Resource<IStarship>[];
        populateAll(path: string): Promise<any>;
    };
    root: string;
    getPage(page?: number, search?: string | undefined): Promise<any>;
    find(predicate?: ((single: IStarship) => boolean) | undefined): Promise<{
        resources: Resource<IStarship>[];
        populateAll(path: string): Promise<any>;
    }>;
    findBySearch(predicate: string[]): Promise<{
        resources: Resource<IStarship>[];
        populateAll(path: string): Promise<any>;
    }>;
};
export declare const Vehicles: {
    new (unparsedResources: IVehicle[]): {
        resources: Resource<IVehicle>[];
        populateAll(path: string): Promise<any>;
    };
    root: string;
    getPage(page?: number, search?: string | undefined): Promise<any>;
    find(predicate?: ((single: IVehicle) => boolean) | undefined): Promise<{
        resources: Resource<IVehicle>[];
        populateAll(path: string): Promise<any>;
    }>;
    findBySearch(predicate: string[]): Promise<{
        resources: Resource<IVehicle>[];
        populateAll(path: string): Promise<any>;
    }>;
};
export {};