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

Module

api/actions/DecodeVinExtended

DecodeVinExtended NHSTA Api Action.

Module Exports:

Types

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

Classes

DecodeVinExtended

Type Definitions

object

# DecodeVinExtendedResponse

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

The search results returned by the NHSTA API request.

FetchResponse FetchResponse

Fetch API Response properties.

View Source api/actions/DecodeVinExtended.ts, line 97

object

# DecodeVinExtendedResults

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

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

View Source api/actions/DecodeVinExtended.ts, line 86