@shaggytools/nhtsa-api-wrapper - v3.0.4 / Exports / api/endpoints/GetVehicleVariableList
Module: api/endpoints/GetVehicleVariableList
Table of contents
Type Aliases
Functions
Type Aliases
GetVehicleVariableListResults
Ƭ GetVehicleVariableListResults: Object
Objects found in the Results array of GetVehicleVariableList endpoint response.
Type declaration
| Name | Type |
|---|---|
DataType | "string" | "int" | "decimal" | "lookup" |
Description | string |
GroupName | string | null |
ID | number |
Name | string |
Defined in
api/endpoints/GetVehicleVariableList.ts:54
Functions
GetVehicleVariableList
▸ GetVehicleVariableList(doFetch?): Promise<NhtsaResponse<GetVehicleVariableListResults>>
💡 More Information
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.
Parameters
| Name | Type | Description |
|---|---|---|
doFetch? | true | Whether to fetch the data or just return the URL (default: true) |
Returns
Promise<NhtsaResponse<GetVehicleVariableListResults>>
- Api Response
object-or- urlstringifdoFetch = false
Defined in
api/endpoints/GetVehicleVariableList.ts:23
▸ GetVehicleVariableList(doFetch): Promise<string>
Parameters
| Name | Type |
|---|---|
doFetch | false |
Returns
Promise<string>