@shaggytools/nhtsa-api-wrapper
Version:
Universal javascript wrapper for the NHTSA.dot.gov VPIC 'vehicles' API, useful for VIN decoding, etc.
32 lines • 1.15 kB
TypeScript
/**
* @module api/endpoints/GetAllMakes
* @category API Endpoints
*/
import type { NhtsaResponse } from '../../types';
/**
* ::: tip :bulb: More Information
* See: [GetAllMakes Documentation](/api/endpoints/get-all-makes)
* :::
*
* `GetAllMakes` provides a list of all the Makes available in the vPIC Dataset.
* Each object in the `Results` array represents the `Make_ID` and the `Make_Name` of
* an individual vehicle Make.
*
* - FYI there are over 10,000 registered makes in the database!
*
* @param {boolean} [doFetch=true] - Whether to fetch the data or just return the URL
* (default: `true`)
* @returns {(Promise<NhtsaResponse<GetAllMakesResults> | string>)} - Api Response `object`
* -or- url `string` if `doFetch = false` (default: `true`)
*/
declare function GetAllMakes(doFetch?: true): Promise<NhtsaResponse<GetAllMakesResults>>;
declare function GetAllMakes(doFetch: false): Promise<string>;
export { GetAllMakes };
/**
* Objects found in the `Results` array of `GetAllMakes` endpoint response.
*/
export type GetAllMakesResults = {
Make_ID: number;
Make_Name: string;
};
//# sourceMappingURL=GetAllMakes.d.ts.map