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