@aerodb/js/dist/index.d.ts

Javascript wrapper for the AeroDB API

import mongoose from 'mongoose';
import AeroClient from './AeroClient';
import { components } from './types/api';
export type * as api from './types/api';
/**
 * Create a new client instance
 */
export declare function createClient(apiKey: string, apiUrl?: string): AeroClient;
export type Airport = components['schemas']['Airport'];
export type Airline = components['schemas']['Airline'];
export type CityCode = components['schemas']['CityCode'];
export type AircraftType = components['schemas']['AircraftType'];
export type Notam = components['schemas']['Notam'];
export type Country = components['schemas']['Country'];
export type SubDivision = components['schemas']['SubDivision'];
export type ApiKey = components['schemas']['ApiKey'];
export type User = components['schemas']['User'];
export type Runway = components['schemas']['Runway'];
/**
 * A callable API resource
 *
 * Use this as a generic type to specify the resource type
 */
export type APIResource = Airport | Airline | ApiKey | CityCode | Runway | User | AircraftType | Notam;
/**
 * Generic type to filter an API resource
 */
export type ResourceFilter<T extends APIResource> = mongoose.FilterQuery<T>;
/**
 * Query parameters for the API request
 */
export type APIQueryParameters<T extends APIResource> = {
    /**
     * Limit the results
     */
    limit?: number;
    /**
     * Page number
     */
    page?: number;
    /**
     * Sort the results
     */
    sort?: Partial<Record<keyof T, 1 | -1>>;
    /**
     * Filter the results
     */
    filter?: ResourceFilter<T>;
};