Important: This documentation applies to v2 of this package.
For v3 docs see vpic.shaggytech.com

Module

api/actions/GetAllManufacturers

GetAllManufacturers NHSTA Api Action.

Module Exports:

Types

View Source api/actions/GetAllManufacturers.ts, line 2

Classes

GetAllManufacturers

Type Definitions

object

# GetAllManufacturersResponse

Type representing the complete response returned by the GetAllManufacturers API Action.

Properties:
Name Type Description
Count number

A count of the items returned in the Results array.

Message string

A message describing the Results array.

SearchCriteria string

Search terms (VIN, WMI, manufacturer, etc.) used in the request URL.

Results Array.<GetAllManufacturersResults>

The search results returned by the NHSTA API request.

FetchResponse FetchResponse

Fetch API Response properties.

View Source api/actions/GetAllManufacturers.ts, line 93

object

# GetAllManufacturersResults

Type representing the structure of objects found in the 'GetAllManufacturersResponse.Results' array.

Properties:
Name Type Attributes Description
Country string
Mfr_CommonName string
Mfr_ID number
Mfr_Name string
VehicleTypes Array.<object>
VehicleTypes[].isPrimary boolean <optional>
VehicleTypes[].name string <optional>

View Source api/actions/GetAllManufacturers.ts, line 79