@shaggytools/nhtsa-api-wrapper/dist/types/api/endpoints/GetVehicleVariableList.d.ts

Universal javascript wrapper for the NHTSA.dot.gov VPIC 'vehicles' API, useful for VIN decoding, etc.

/**
 * @module api/endpoints/GetVehicleVariableList
 * @category API Endpoints
 */
import type { NhtsaResponse } from '../../types';
/**
 * ::: tip :bulb: More Information
 * See: [GetVehicleVariableList Documentation](/api/endpoints/get-vehicle-variable-list)
 * :::
 *
 * `GetVehicleVariableList` provides a list of all the Vehicle related variables that are in the
 * vPIC dataset. Information on the name, description and the type of the variable is provided.
 *
 * @param {boolean} [doFetch=true] - Whether to fetch the data or just return the URL
 * (default: `true`)
 * @returns {(Promise<NhtsaResponse<GetVehicleVariableListResults> | string>)} - Api Response
 * `object` -or- url `string` if `doFetch = false`
 */
declare function GetVehicleVariableList(doFetch?: true): Promise<NhtsaResponse<GetVehicleVariableListResults>>;
declare function GetVehicleVariableList(doFetch: false): Promise<string>;
export { GetVehicleVariableList };
/**
 * Objects found in the `Results` array of `GetVehicleVariableList` endpoint response.
 */
export type GetVehicleVariableListResults = {
    DataType: 'string' | 'int' | 'decimal' | 'lookup';
    Description: string;
    GroupName: string | null;
    ID: number;
    Name: string;
};
//# sourceMappingURL=GetVehicleVariableList.d.ts.map