@shaggytools/nhtsa-api-wrapper - v3.0.4 / Exports / api/endpoints/GetAllManufacturers

Module: api/endpoints/GetAllManufacturers ​

Table of contents ​

Type Aliases ​

• GetAllManufacturersResults

Functions ​

• GetAllManufacturers

Type Aliases ​

GetAllManufacturersResults ​

Ƭ GetAllManufacturersResults: Object

Objects found in the Results array of GetAllManufacturers endpoint response.

Type declaration ​

Defined in ​

api/endpoints/GetAllManufacturers.ts:111

Functions ​

GetAllManufacturers ​

▸ GetAllManufacturers(doFetch?, _dummy?): Promise<NhtsaResponse<GetAllManufacturersResults>>

GetAllManufacturers provides a list of all the Manufacturers available in the vPIC Dataset.

params.manufacturerType is optional but allows the user to filter the list based on manufacturer type. Types include 'Incomplete Vehicles', 'Completed Vehicle Manufacturer', 'Incomplete Vehicle Manufacturer', 'Intermediate Manufacturer', 'Final-Stage Manufacturer', 'Alterer', or any partial match of those strings.

params.page is optional and used to specify (n)th page of results. Results are provided in pages of 100 items.

Parameters ​

Returns ​

Promise<NhtsaResponse<GetAllManufacturersResults>>

• Api Response object -or- url string if doFetch = false

Defined in ​

api/endpoints/GetAllManufacturers.ts:33

▸ GetAllManufacturers(doFetch?, _dummy?): Promise<string>

Parameters ​

Returns ​

Promise<string>

Defined in ​

api/endpoints/GetAllManufacturers.ts:38

▸ GetAllManufacturers(params, doFetch): Promise<string>

Parameters ​

Returns ​

Promise<string>

Defined in ​

api/endpoints/GetAllManufacturers.ts:43

▸ GetAllManufacturers(params?, doFetch?): Promise<NhtsaResponse<GetAllManufacturersResults>>

Parameters ​

Returns ​

Promise<NhtsaResponse<GetAllManufacturersResults>>

Defined in ​

api/endpoints/GetAllManufacturers.ts:51