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

Module

api/actions/DecodeVin

DecodeVin NHSTA Api Action.

Module Exports:

Types

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

Classes

DecodeVin

Type Definitions

object

# DecodeVinResponse

Type representing the complete response returned by the DecodeVin 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.<DecodeVinResults>

The search results returned by the NHSTA API request.

FetchResponse FetchResponse

Fetch API Response properties.

View Source api/actions/DecodeVin.ts, line 90

object

# DecodeVinResults

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

Properties:
Name Type Description
Value string | null
ValueId string | null
Variable string
VariableId number

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