@shaggytools/nhtsa-api-wrapper - v3.0.4 / Exports / api/endpoints/GetVehicleTypesForMake
Module: api/endpoints/GetVehicleTypesForMake
Table of contents
Type Aliases
Functions
Type Aliases
GetVehicleTypesForMakeResults
Ƭ GetVehicleTypesForMakeResults: Object
Objects found in the Results
array of GetVehicleTypesForMake
endpoint response.
Type declaration
Name | Type |
---|---|
MakeId | number |
MakeName | string |
VehicleTypeId | number |
VehicleTypeName | string |
Defined in
api/endpoints/GetVehicleTypesForMake.ts:73
Functions
GetVehicleTypesForMake
▸ GetVehicleTypesForMake(makeName
, doFetch?
): Promise
<NhtsaResponse
<GetVehicleTypesForMakeResults
>>
💡 More Information
GetVehicleTypesForMake
returns all the Vehicle Types in the vPIC dataset for a specified Make, whose name is LIKE the make name in the vPIC Dataset.
makeName
can be a partial name, or a full name for more specificity, e.g., "Merc", "Mercedes Benz", etc.
Parameters
Name | Type | Description |
---|---|---|
makeName | string | Name of the vehicle make to search |
doFetch? | true | Whether to fetch the data or just return the URL (default: true ) |
Returns
Promise
<NhtsaResponse
<GetVehicleTypesForMakeResults
>>
- Api Response
object
-or- urlstring
ifdoFetch = false
Defined in
api/endpoints/GetVehicleTypesForMake.ts:27
▸ GetVehicleTypesForMake(makeName
, doFetch
): Promise
<string
>
Parameters
Name | Type |
---|---|
makeName | string |
doFetch | false |
Returns
Promise
<string
>