diff --git a/apps/docs/.prettierignore b/apps/docs/.prettierignore new file mode 100644 index 00000000..aa2c5cd5 --- /dev/null +++ b/apps/docs/.prettierignore @@ -0,0 +1 @@ +**/typedoc/** \ No newline at end of file diff --git a/apps/docs/.vitepress/config.ts b/apps/docs/.vitepress/config.ts index 9da9cf46..e206dc21 100644 --- a/apps/docs/.vitepress/config.ts +++ b/apps/docs/.vitepress/config.ts @@ -42,10 +42,6 @@ export default withPwa( outline: 'deep', nav: nav(), sidebar: sidebar(), - - // search: { - // provider: 'local', - // }, algolia: getAlgoliaConfig(process.env), editLink: { diff --git a/apps/docs/.vitepress/menu-links.ts b/apps/docs/.vitepress/menu-links.ts index f6e5b442..6460baa3 100644 --- a/apps/docs/.vitepress/menu-links.ts +++ b/apps/docs/.vitepress/menu-links.ts @@ -76,168 +76,150 @@ const vpicEndpointLinks = [ const typedocLinks = [ { - text: 'Modules', + text: '/api', collapsed: true, items: [ + { text: 'Index', link: '/typedoc/api' }, { - text: '/api', + text: 'useNHTSA', + link: '/typedoc/api/useNHTSA', + }, + { + text: '/endpoints/', collapsed: true, items: [ - { text: 'Index', link: '/typedoc/modules/api' }, + { text: 'Index', link: '/typedoc/api/endpoints' }, { - text: 'useNHTSA', - link: '/typedoc/modules/api_useNHTSA', + text: 'DecodeVin', + link: '/typedoc/api/endpoints/DecodeVin', }, { - text: '/endpoints/', - collapsed: true, - items: [ - { text: 'Index', link: '/typedoc/modules/api_endpoints' }, - { - text: 'DecodeVin', - link: '/typedoc/modules/api_endpoints_DecodeVin', - }, - { - text: 'DecodeVinExtended', - link: '/typedoc/modules/api_endpoints_DecodeVinExtended', - }, - { - text: 'DecodeVinValues', - link: '/typedoc/modules/api_endpoints_DecodeVinValues', - }, - { - text: 'DecodeVinValuesBatch', - link: '/typedoc/modules/api_endpoints_DecodeVinValuesBatch', - }, - { - text: 'DecodeVinValuesExtended', - link: '/typedoc/modules/api_endpoints_DecodeVinValuesExtended', - }, - { - text: 'DecodeWMI', - link: '/typedoc/modules/api_endpoints_DecodeWMI', - }, - { - text: 'GetAllMakes', - link: '/typedoc/modules/api_endpoints_GetAllMakes', - }, - { - text: 'GetAllManufacturers', - link: '/typedoc/modules/api_endpoints_GetAllManufacturers', - }, - { - text: 'GetCanadianVehicleSpecifications', - link: '/typedoc/modules/api_endpoints_GetCanadianVehicleSpecifications', - }, - { - text: 'GetEquipmentPlantCodes', - link: '/typedoc/modules/api_endpoints_GetEquipmentPlantCodes', - }, - { - text: 'GetMakeForManufacturer', - link: '/typedoc/modules/api_endpoints_GetMakeForManufacturer', - }, - { - text: 'GetMakesForManufacturerAndYear', - link: '/typedoc/modules/api_endpoints_GetMakesForManufacturerAndYear', - }, - { - text: 'GetMakesForVehicleType', - link: '/typedoc/modules/api_endpoints_GetMakesForVehicleType', - }, - { - text: 'GetManufacturerDetails', - link: '/typedoc/modules/api_endpoints_GetManufacturerDetails', - }, - { - text: 'GetModelsForMake', - link: '/typedoc/modules/api_endpoints_GetModelsForMake', - }, - { - text: 'GetModelsForMakeId', - link: '/typedoc/modules/api_endpoints_GetModelsForMakeId', - }, - { - text: 'GetModelsForMakeIdYear', - link: '/typedoc/modules/api_endpoints_GetModelsForMakeIdYear', - }, - { - text: 'GetModelsForMakeYear', - link: '/typedoc/modules/api_endpoints_GetModelsForMakeYear', - }, - { - text: 'GetParts', - link: '/typedoc/modules/api_endpoints_GetParts', - }, - { - text: 'GetVehicleTypesForMake', - link: '/typedoc/modules/api_endpoints_GetVehicleTypesForMake', - }, - { - text: 'GetVehicleTypesForMakeId', - link: '/typedoc/modules/api_endpoints_GetVehicleTypesForMakeId', - }, - { - text: 'GetVehicleVariableList', - link: '/typedoc/modules/api_endpoints_GetVehicleVariableList', - }, - { - text: 'GetVehicleVariableValuesList', - link: '/typedoc/modules/api_endpoints_GetVehicleVariableValuesList', - }, - { - text: 'GetWMIsForManufacturer', - link: '/typedoc/modules/api_endpoints_GetWMIsForManufacturer', - }, - ], + text: 'DecodeVinExtended', + link: '/typedoc/api/endpoints/DecodeVinExtended', + }, + { + text: 'DecodeVinValues', + link: '/typedoc/api/endpoints/DecodeVinValues', + }, + { + text: 'DecodeVinValuesBatch', + link: '/typedoc/api/endpoints/DecodeVinValuesBatch', + }, + { + text: 'DecodeVinValuesExtended', + link: '/typedoc/api/endpoints/DecodeVinValuesExtended', + }, + { + text: 'DecodeWMI', + link: '/typedoc/api/endpoints/DecodeWMI', + }, + { + text: 'GetAllMakes', + link: '/typedoc/api/endpoints/GetAllMakes', + }, + { + text: 'GetAllManufacturers', + link: '/typedoc/api/endpoints/GetAllManufacturers', + }, + { + text: 'GetCanadianVehicleSpecifications', + link: '/typedoc/api/endpoints/GetCanadianVehicleSpecifications', + }, + { + text: 'GetEquipmentPlantCodes', + link: '/typedoc/api/endpoints/GetEquipmentPlantCodes', + }, + { + text: 'GetMakeForManufacturer', + link: '/typedoc/api/endpoints/GetMakeForManufacturer', }, - ], - }, - { - text: '/utils', - collapsed: true, - items: [ - { text: 'Index', link: '/typedoc/modules/utils' }, { - text: 'argHandler', - link: '/typedoc/modules/utils_argHandler', + text: 'GetMakesForManufacturerAndYear', + link: '/typedoc/api/endpoints/GetMakesForManufacturerAndYear', }, { - text: 'errorHandler', - link: '/typedoc/modules/utils_errorHandler', + text: 'GetMakesForVehicleType', + link: '/typedoc/api/endpoints/GetMakesForVehicleType', }, { - text: 'getTypeof', - link: '/typedoc/modules/utils_getTypeof', + text: 'GetManufacturerDetails', + link: '/typedoc/api/endpoints/GetManufacturerDetails', }, { - text: 'isValidVin', - link: '/typedoc/modules/utils_isValidVin', + text: 'GetModelsForMake', + link: '/typedoc/api/endpoints/GetModelsForMake', }, { - text: 'queryString', - link: '/typedoc/modules/utils_queryString', + text: 'GetModelsForMakeId', + link: '/typedoc/api/endpoints/GetModelsForMakeId', + }, + { + text: 'GetModelsForMakeIdYear', + link: '/typedoc/api/endpoints/GetModelsForMakeIdYear', + }, + { + text: 'GetModelsForMakeYear', + link: '/typedoc/api/endpoints/GetModelsForMakeYear', + }, + { + text: 'GetParts', + link: '/typedoc/api/endpoints/GetParts', + }, + { + text: 'GetVehicleTypesForMake', + link: '/typedoc/api/endpoints/GetVehicleTypesForMake', + }, + { + text: 'GetVehicleTypesForMakeId', + link: '/typedoc/api/endpoints/GetVehicleTypesForMakeId', + }, + { + text: 'GetVehicleVariableList', + link: '/typedoc/api/endpoints/GetVehicleVariableList', + }, + { + text: 'GetVehicleVariableValuesList', + link: '/typedoc/api/endpoints/GetVehicleVariableValuesList', + }, + { + text: 'GetWMIsForManufacturer', + link: '/typedoc/api/endpoints/GetWMIsForManufacturer', }, ], }, ], }, { - text: 'Types', + text: '/utils', collapsed: true, items: [ - { text: 'Index', link: '/typedoc/modules/types' }, - { text: '/api/types', link: '/typedoc/modules/api_types' }, + { text: 'Index', link: '/typedoc/utils' }, + { + text: 'argHandler', + link: '/typedoc/utils/argHandler', + }, { - text: '/api/endpoints/types', - link: '/typedoc/modules/api_endpoints_types', + text: 'errorHandler', + link: '/typedoc/utils/errorHandler', }, { - text: '/utils/types', - link: '/typedoc/modules/utils_types', + text: 'getTypeof', + link: '/typedoc/utils/getTypeof', + }, + { + text: 'isValidVin', + link: '/typedoc/utils/isValidVin', + }, + { + text: 'queryString', + link: '/typedoc/utils/queryString', }, ], }, + { + text: 'Types Index', + link: '/typedoc/types', + }, ] export type LinkGroup = 'guide' | 'api' | 'typedocs' diff --git a/apps/docs/package.json b/apps/docs/package.json index f5381bc6..5e58ae90 100644 --- a/apps/docs/package.json +++ b/apps/docs/package.json @@ -12,7 +12,7 @@ "preview": "vitepress preview", "lint": "eslint .", "lint:fix": "eslint . --fix", - "format": "prettier --write \"src/**/*.{ts,tsx,md}\"", + "format": "prettier --write \"src/**/*.{js,ts,md}\"", "format:typedoc": "prettier --write \"src/typedoc/**/*.md\"", "clean": "rimraf .vitepress/dist .vitepress/cache .turbo", "clean:all": "pnpm run clean && rimraf node_modules" diff --git a/apps/docs/src/api/endpoints/decode-vin-extended.md b/apps/docs/src/api/endpoints/decode-vin-extended.md index b6a05d32..531db572 100644 --- a/apps/docs/src/api/endpoints/decode-vin-extended.md +++ b/apps/docs/src/api/endpoints/decode-vin-extended.md @@ -15,7 +15,7 @@ async function DecodeVinExtended ( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/modules/api_endpoints_DecodeVinExtended) +See: [Package Reference](../../typedoc/api/endpoints/DecodeVinExtended) ::: ## Description diff --git a/apps/docs/src/api/endpoints/decode-vin-values-batch.md b/apps/docs/src/api/endpoints/decode-vin-values-batch.md index 40cb3fb3..05b4b8cd 100644 --- a/apps/docs/src/api/endpoints/decode-vin-values-batch.md +++ b/apps/docs/src/api/endpoints/decode-vin-values-batch.md @@ -10,7 +10,7 @@ async function DecodeVinValuesBatch( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/modules/api_endpoints_DecodeVinValuesBatch) +See: [Package Reference](../../typedoc/api/endpoints/DecodeVinValuesBatch) ::: ## Description diff --git a/apps/docs/src/api/endpoints/decode-vin-values-extended.md b/apps/docs/src/api/endpoints/decode-vin-values-extended.md index b59941da..849e86d6 100644 --- a/apps/docs/src/api/endpoints/decode-vin-values-extended.md +++ b/apps/docs/src/api/endpoints/decode-vin-values-extended.md @@ -15,7 +15,7 @@ async function DecodeVinValuesExtended( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/modules/api_endpoints_DecodeVinValuesExtended) +See: [Package Reference](../../typedoc/api/endpoints/DecodeVinValuesExtended) ::: ## Description diff --git a/apps/docs/src/api/endpoints/decode-vin-values.md b/apps/docs/src/api/endpoints/decode-vin-values.md index 5f4551ba..857ab9be 100644 --- a/apps/docs/src/api/endpoints/decode-vin-values.md +++ b/apps/docs/src/api/endpoints/decode-vin-values.md @@ -15,7 +15,7 @@ async function DecodeVinValues( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/modules/api_endpoints_DecodeVinValues) +See: [Package Reference](../../typedoc/api/endpoints/DecodeVinValues) ::: ## Description diff --git a/apps/docs/src/api/endpoints/decode-vin.md b/apps/docs/src/api/endpoints/decode-vin.md index 93f611ea..d4408bef 100644 --- a/apps/docs/src/api/endpoints/decode-vin.md +++ b/apps/docs/src/api/endpoints/decode-vin.md @@ -15,7 +15,7 @@ async function DecodeVin( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/modules/api_endpoints_DecodeVin) +See: [Package Reference](../../typedoc/api/endpoints/DecodeVin) ::: ## Description diff --git a/apps/docs/src/api/endpoints/decode-wmi.md b/apps/docs/src/api/endpoints/decode-wmi.md index 1a950221..a86ea9ec 100644 --- a/apps/docs/src/api/endpoints/decode-wmi.md +++ b/apps/docs/src/api/endpoints/decode-wmi.md @@ -10,7 +10,7 @@ async function DecodeWMI( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/modules/api_endpoints_DecodeWMI) +See: [Package Reference](../../typedoc/api/endpoints/DecodeWMI) ::: ## Description diff --git a/apps/docs/src/api/endpoints/get-all-makes.md b/apps/docs/src/api/endpoints/get-all-makes.md index b8157141..7e2d688f 100644 --- a/apps/docs/src/api/endpoints/get-all-makes.md +++ b/apps/docs/src/api/endpoints/get-all-makes.md @@ -9,7 +9,7 @@ async function GetAllMakes( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/modules/api_endpoints_GetAllMakes) +See: [Package Reference](../../typedoc/api/endpoints/GetAllMakes) ::: ## Description diff --git a/apps/docs/src/api/endpoints/get-all-manufacturers.md b/apps/docs/src/api/endpoints/get-all-manufacturers.md index e63048b1..7b386d55 100644 --- a/apps/docs/src/api/endpoints/get-all-manufacturers.md +++ b/apps/docs/src/api/endpoints/get-all-manufacturers.md @@ -15,7 +15,7 @@ async function GetAllManufacturers( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/modules/api_endpoints_GetAllManufacturers) +See: [Package Reference](../../typedoc/api/endpoints/GetAllManufacturers) ::: ## Description diff --git a/apps/docs/src/api/endpoints/get-canadian-vehicle-specifications.md b/apps/docs/src/api/endpoints/get-canadian-vehicle-specifications.md index d82eb80b..7eb875e3 100644 --- a/apps/docs/src/api/endpoints/get-canadian-vehicle-specifications.md +++ b/apps/docs/src/api/endpoints/get-canadian-vehicle-specifications.md @@ -15,7 +15,7 @@ async function GetCanadianVehicleSpecifications( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/modules/api_endpoints_GetCanadianVehicleSpecifications) +See: [Package Reference](../../typedoc/api/endpoints/GetCanadianVehicleSpecifications) ::: ## Description diff --git a/apps/docs/src/api/endpoints/get-equipment-plant-codes.md b/apps/docs/src/api/endpoints/get-equipment-plant-codes.md index 14d1ecca..28a48c6a 100644 --- a/apps/docs/src/api/endpoints/get-equipment-plant-codes.md +++ b/apps/docs/src/api/endpoints/get-equipment-plant-codes.md @@ -31,7 +31,7 @@ async function GetEquipmentPlantCodes( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/modules/api_endpoints_GetEquipmentPlantCodes) +See: [Package Reference](../../typedoc/api/endpoints/GetEquipmentPlantCodes) ::: ## Description diff --git a/apps/docs/src/api/endpoints/get-make-for-manufacturer.md b/apps/docs/src/api/endpoints/get-make-for-manufacturer.md index 510034c3..b653f8a9 100644 --- a/apps/docs/src/api/endpoints/get-make-for-manufacturer.md +++ b/apps/docs/src/api/endpoints/get-make-for-manufacturer.md @@ -10,7 +10,7 @@ async function GetMakeForManufacturer( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/modules/api_endpoints_GetMakeForManufacturer) +See: [Package Reference](../../typedoc/api/endpoints/GetMakeForManufacturer) ::: ## Description diff --git a/apps/docs/src/api/endpoints/get-makes-for-manufacturer-and-year.md b/apps/docs/src/api/endpoints/get-makes-for-manufacturer-and-year.md index da1bd756..fba6fb80 100644 --- a/apps/docs/src/api/endpoints/get-makes-for-manufacturer-and-year.md +++ b/apps/docs/src/api/endpoints/get-makes-for-manufacturer-and-year.md @@ -13,7 +13,7 @@ async function GetMakesForManufacturerAndYear( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/modules/api_endpoints_GetMakesForManufacturerAndYear) +See: [Package Reference](../../typedoc/api/endpoints/GetMakesForManufacturerAndYear) ::: ## Description diff --git a/apps/docs/src/api/endpoints/get-makes-for-vehicle-type.md b/apps/docs/src/api/endpoints/get-makes-for-vehicle-type.md index b8922096..893da219 100644 --- a/apps/docs/src/api/endpoints/get-makes-for-vehicle-type.md +++ b/apps/docs/src/api/endpoints/get-makes-for-vehicle-type.md @@ -10,7 +10,7 @@ async function GetMakesForVehicleType( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/modules/api_endpoints_GetMakesForVehicleType) +See: [Package Reference](../../typedoc/api/endpoints/GetMakesForVehicleType) ::: ## Description diff --git a/apps/docs/src/api/endpoints/get-manufacturer-details.md b/apps/docs/src/api/endpoints/get-manufacturer-details.md index 7ee32cd6..ffb0addc 100644 --- a/apps/docs/src/api/endpoints/get-manufacturer-details.md +++ b/apps/docs/src/api/endpoints/get-manufacturer-details.md @@ -10,7 +10,7 @@ async function GetManufacturerDetails( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/modules/api_endpoints_GetManufacturerDetails) +See: [Package Reference](../../typedoc/api/endpoints/GetManufacturerDetails) ::: ## Description diff --git a/apps/docs/src/api/endpoints/get-models-for-make-id-year.md b/apps/docs/src/api/endpoints/get-models-for-make-id-year.md index d92bd214..fef719b9 100644 --- a/apps/docs/src/api/endpoints/get-models-for-make-id-year.md +++ b/apps/docs/src/api/endpoints/get-models-for-make-id-year.md @@ -15,7 +15,7 @@ async function GetModelsForMakeIdYear( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/modules/api_endpoints_GetModelsForMakeIdYear) +See: [Package Reference](../../typedoc/api/endpoints/GetModelsForMakeIdYear) ::: ## Description diff --git a/apps/docs/src/api/endpoints/get-models-for-make-id.md b/apps/docs/src/api/endpoints/get-models-for-make-id.md index 84a26573..133bb641 100644 --- a/apps/docs/src/api/endpoints/get-models-for-make-id.md +++ b/apps/docs/src/api/endpoints/get-models-for-make-id.md @@ -10,7 +10,7 @@ async function GetModelsForMakeId( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/modules/api_endpoints_GetModelsForMakeId) +See: [Package Reference](../../typedoc/api/endpoints/GetModelsForMakeId) ::: ## Description diff --git a/apps/docs/src/api/endpoints/get-models-for-make-year.md b/apps/docs/src/api/endpoints/get-models-for-make-year.md index 004bdd7f..aff0cdfb 100644 --- a/apps/docs/src/api/endpoints/get-models-for-make-year.md +++ b/apps/docs/src/api/endpoints/get-models-for-make-year.md @@ -15,7 +15,7 @@ async function GetModelsForMakeYear( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/modules/api_endpoints_GetModelsForMakeYear) +See: [Package Reference](../../typedoc/api/endpoints/GetModelsForMakeYear) ::: ## Description diff --git a/apps/docs/src/api/endpoints/get-models-for-make.md b/apps/docs/src/api/endpoints/get-models-for-make.md index c9eff80f..9d816c83 100644 --- a/apps/docs/src/api/endpoints/get-models-for-make.md +++ b/apps/docs/src/api/endpoints/get-models-for-make.md @@ -10,7 +10,7 @@ async function GetModelsForMake( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/modules/api_endpoints_GetModelsForMake) +See: [Package Reference](../../typedoc/api/endpoints/GetModelsForMake) ::: ## Description diff --git a/apps/docs/src/api/endpoints/get-parts.md b/apps/docs/src/api/endpoints/get-parts.md index e7a5c9c5..f594c62b 100644 --- a/apps/docs/src/api/endpoints/get-parts.md +++ b/apps/docs/src/api/endpoints/get-parts.md @@ -18,7 +18,7 @@ async function GetParts( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/modules/api_endpoints_GetParts) +See: [Package Reference](../../typedoc/api/endpoints/GetParts) ::: ## Description diff --git a/apps/docs/src/api/endpoints/get-vehicle-types-for-make-id.md b/apps/docs/src/api/endpoints/get-vehicle-types-for-make-id.md index 416ab58b..54826f48 100644 --- a/apps/docs/src/api/endpoints/get-vehicle-types-for-make-id.md +++ b/apps/docs/src/api/endpoints/get-vehicle-types-for-make-id.md @@ -10,7 +10,7 @@ async function GetVehicleTypesForMakeId( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/modules/api_endpoints_GetVehicleTypesForMakeId) +See: [Package Reference](../../typedoc/api/endpoints/GetVehicleTypesForMakeId) ::: ## Description diff --git a/apps/docs/src/api/endpoints/get-vehicle-types-for-make.md b/apps/docs/src/api/endpoints/get-vehicle-types-for-make.md index fa7a2719..96861239 100644 --- a/apps/docs/src/api/endpoints/get-vehicle-types-for-make.md +++ b/apps/docs/src/api/endpoints/get-vehicle-types-for-make.md @@ -10,7 +10,7 @@ async function GetVehicleTypesForMake( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/modules/api_endpoints_GetVehicleTypesForMake) +See: [Package Reference](../../typedoc/api/endpoints/GetVehicleTypesForMake) ::: ## Description diff --git a/apps/docs/src/api/endpoints/get-vehicle-variable-list.md b/apps/docs/src/api/endpoints/get-vehicle-variable-list.md index b59d7376..d4b6225c 100644 --- a/apps/docs/src/api/endpoints/get-vehicle-variable-list.md +++ b/apps/docs/src/api/endpoints/get-vehicle-variable-list.md @@ -9,7 +9,7 @@ async function GetVehicleVariableList( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/modules/api_endpoints_GetVehicleVariableList) +See: [Package Reference](../../typedoc/api/endpoints/GetVehicleVariableList) ::: ## Description diff --git a/apps/docs/src/api/endpoints/get-vehicle-variable-values-list.md b/apps/docs/src/api/endpoints/get-vehicle-variable-values-list.md index 978f2f01..eb333c60 100644 --- a/apps/docs/src/api/endpoints/get-vehicle-variable-values-list.md +++ b/apps/docs/src/api/endpoints/get-vehicle-variable-values-list.md @@ -10,7 +10,7 @@ async function GetVehicleVariableValuesList( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/modules/api_endpoints_GetVehicleVariableValuesList) +See: [Package Reference](../../typedoc/api/endpoints/GetVehicleVariableValuesList) ::: ## Description diff --git a/apps/docs/src/api/endpoints/get-wmis-for-manufacturer.md b/apps/docs/src/api/endpoints/get-wmis-for-manufacturer.md index 4a1bed18..e584f7e0 100644 --- a/apps/docs/src/api/endpoints/get-wmis-for-manufacturer.md +++ b/apps/docs/src/api/endpoints/get-wmis-for-manufacturer.md @@ -13,7 +13,7 @@ async function GetWMIsForManufacturer( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/modules/api_endpoints_GetWMIsForManufacturer) +See: [Package Reference](../../typedoc/api/endpoints/GetWMIsForManufacturer) ::: ## Description diff --git a/apps/docs/src/guide/getting-started.md b/apps/docs/src/guide/getting-started.md index 520252e4..7aebee01 100644 --- a/apps/docs/src/guide/getting-started.md +++ b/apps/docs/src/guide/getting-started.md @@ -58,7 +58,7 @@ Further Reading: documentation. - The structure of `Results[0]` in the above example can be seen on the - [Typedocs - DecodeVinValuesResults](../typedoc/modules/api_endpoints_DecodeVinValues#decodevinvaluesresults) + [Typedocs - DecodeVinValuesResults](../typedoc/api/endpoints/DecodeVinValues#decodevinvaluesresults) page. --- diff --git a/apps/docs/src/guide/typescript.md b/apps/docs/src/guide/typescript.md index 5010d36c..22ddba1b 100644 --- a/apps/docs/src/guide/typescript.md +++ b/apps/docs/src/guide/typescript.md @@ -58,7 +58,8 @@ function. For example `DecodeVin` has a `DecodeVinResults` type, `GetAllMakes` h `GetAllMakesResults` type, etc. A few endpoints also have other associated types, such as -[`DecodeVinExtendedVariable`](../typedoc/modules/api_endpoints_DecodeVinExtended#decodevinextendedvariable) +typedoc/api/endpoints/DecodeVinValues/type-aliases/DecodeVinValuesResults +[`DecodeVinExtendedVariable`](../typedoc/api/endpoints/DecodeVinExtended#DecodeVinExtendedVariable) that describe possible `Variable` values found in the `Results` array of the `DecodeVinExtended` endpoint. @@ -66,7 +67,7 @@ endpoint. ::: tip :mag: See Also: -The [Typedocs - Types](../typedoc/modules/types) page lists all of the types this +The [Typedocs - Types](../typedoc/types) page lists all of the types this package exports and their structure.
diff --git a/apps/docs/src/guide/vin-decoding.md b/apps/docs/src/guide/vin-decoding.md index b51ea863..d7e319b0 100644 --- a/apps/docs/src/guide/vin-decoding.md +++ b/apps/docs/src/guide/vin-decoding.md @@ -52,7 +52,7 @@ object. This object is the decoded data for the VIN. - [DecodeVinValues](../api/endpoints/decode-vin-values) - [DecodeVinValues Example Response](../api/endpoints/decode-vin-values#returns) -- [Type - DecodeVinValuesResults](../typedoc/modules/api_endpoints_DecodeVinValues#decodevinvaluesresults) +- [Type - DecodeVinValuesResults](../typedoc/api/endpoints/DecodeVinValues#decodevinvaluesresults) ::: diff --git a/apps/docs/src/parts/package-exports-types.md b/apps/docs/src/parts/package-exports-types.md index b368395d..ca951ec9 100644 --- a/apps/docs/src/parts/package-exports-types.md +++ b/apps/docs/src/parts/package-exports-types.md @@ -1,7 +1,7 @@ ## Types This Package Exports ::: tip :bulb: INFO -All types used by this package can be found in the [Typedoc Section](../typedoc/modules/types). +All types used by this package can be found in the [Typedoc Section](../typedoc/types). ::: Each endpoint function returns a `NhtsaResponse` object where `T` is one of the `Results` types diff --git a/apps/docs/src/typedoc/api.md b/apps/docs/src/typedoc/api.md new file mode 100644 index 00000000..204ee303 --- /dev/null +++ b/apps/docs/src/typedoc/api.md @@ -0,0 +1,138 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](modules.md) / api + +# api + +## Contents + +- [References](api.md#references) + - [DecodeVin](api.md#decodevin) + - [DecodeVinExtended](api.md#decodevinextended) + - [DecodeVinValues](api.md#decodevinvalues) + - [DecodeVinValuesBatch](api.md#decodevinvaluesbatch) + - [DecodeVinValuesExtended](api.md#decodevinvaluesextended) + - [DecodeWMI](api.md#decodewmi) + - [GetAllMakes](api.md#getallmakes) + - [GetAllManufacturers](api.md#getallmanufacturers) + - [GetCanadianVehicleSpecifications](api.md#getcanadianvehiclespecifications) + - [GetEquipmentPlantCodes](api.md#getequipmentplantcodes) + - [GetMakeForManufacturer](api.md#getmakeformanufacturer) + - [GetMakesForManufacturerAndYear](api.md#getmakesformanufacturerandyear) + - [GetMakesForVehicleType](api.md#getmakesforvehicletype) + - [GetManufacturerDetails](api.md#getmanufacturerdetails) + - [GetModelsForMake](api.md#getmodelsformake) + - [GetModelsForMakeId](api.md#getmodelsformakeid) + - [GetModelsForMakeIdYear](api.md#getmodelsformakeidyear) + - [GetModelsForMakeYear](api.md#getmodelsformakeyear) + - [GetParts](api.md#getparts) + - [GetVehicleTypesForMake](api.md#getvehicletypesformake) + - [GetVehicleTypesForMakeId](api.md#getvehicletypesformakeid) + - [GetVehicleVariableList](api.md#getvehiclevariablelist) + - [GetVehicleVariableValuesList](api.md#getvehiclevariablevalueslist) + - [GetWMIsForManufacturer](api.md#getwmisformanufacturer) + - [useNHTSA](api.md#usenhtsa) + +## References + +### DecodeVin + +Re-exports [DecodeVin](api/endpoints/DecodeVin.md#decodevin) + +### DecodeVinExtended + +Re-exports [DecodeVinExtended](api/endpoints/DecodeVinExtended.md#decodevinextended) + +### DecodeVinValues + +Re-exports [DecodeVinValues](api/endpoints/DecodeVinValues.md#decodevinvalues) + +### DecodeVinValuesBatch + +Re-exports [DecodeVinValuesBatch](api/endpoints/DecodeVinValuesBatch.md#decodevinvaluesbatch) + +### DecodeVinValuesExtended + +Re-exports [DecodeVinValuesExtended](api/endpoints/DecodeVinValuesExtended.md#decodevinvaluesextended) + +### DecodeWMI + +Re-exports [DecodeWMI](api/endpoints/DecodeWMI.md#decodewmi) + +### GetAllMakes + +Re-exports [GetAllMakes](api/endpoints/GetAllMakes.md#getallmakes) + +### GetAllManufacturers + +Re-exports [GetAllManufacturers](api/endpoints/GetAllManufacturers.md#getallmanufacturers) + +### GetCanadianVehicleSpecifications + +Re-exports [GetCanadianVehicleSpecifications](api/endpoints/GetCanadianVehicleSpecifications.md#getcanadianvehiclespecifications) + +### GetEquipmentPlantCodes + +Re-exports [GetEquipmentPlantCodes](api/endpoints/GetEquipmentPlantCodes.md#getequipmentplantcodes) + +### GetMakeForManufacturer + +Re-exports [GetMakeForManufacturer](api/endpoints/GetMakeForManufacturer.md#getmakeformanufacturer) + +### GetMakesForManufacturerAndYear + +Re-exports [GetMakesForManufacturerAndYear](api/endpoints/GetMakesForManufacturerAndYear.md#getmakesformanufacturerandyear) + +### GetMakesForVehicleType + +Re-exports [GetMakesForVehicleType](api/endpoints/GetMakesForVehicleType.md#getmakesforvehicletype) + +### GetManufacturerDetails + +Re-exports [GetManufacturerDetails](api/endpoints/GetManufacturerDetails.md#getmanufacturerdetails) + +### GetModelsForMake + +Re-exports [GetModelsForMake](api/endpoints/GetModelsForMake.md#getmodelsformake) + +### GetModelsForMakeId + +Re-exports [GetModelsForMakeId](api/endpoints/GetModelsForMakeId.md#getmodelsformakeid) + +### GetModelsForMakeIdYear + +Re-exports [GetModelsForMakeIdYear](api/endpoints/GetModelsForMakeIdYear.md#getmodelsformakeidyear) + +### GetModelsForMakeYear + +Re-exports [GetModelsForMakeYear](api/endpoints/GetModelsForMakeYear.md#getmodelsformakeyear) + +### GetParts + +Re-exports [GetParts](api/endpoints/GetParts.md#getparts) + +### GetVehicleTypesForMake + +Re-exports [GetVehicleTypesForMake](api/endpoints/GetVehicleTypesForMake.md#getvehicletypesformake) + +### GetVehicleTypesForMakeId + +Re-exports [GetVehicleTypesForMakeId](api/endpoints/GetVehicleTypesForMakeId.md#getvehicletypesformakeid) + +### GetVehicleVariableList + +Re-exports [GetVehicleVariableList](api/endpoints/GetVehicleVariableList.md#getvehiclevariablelist) + +### GetVehicleVariableValuesList + +Re-exports [GetVehicleVariableValuesList](api/endpoints/GetVehicleVariableValuesList.md#getvehiclevariablevalueslist) + +### GetWMIsForManufacturer + +Re-exports [GetWMIsForManufacturer](api/endpoints/GetWMIsForManufacturer.md#getwmisformanufacturer) + +### useNHTSA + +Re-exports [useNHTSA](api/useNHTSA.md#usenhtsa) diff --git a/apps/docs/src/typedoc/api/endpoints.md b/apps/docs/src/typedoc/api/endpoints.md new file mode 100644 index 00000000..314f1c8d --- /dev/null +++ b/apps/docs/src/typedoc/api/endpoints.md @@ -0,0 +1,133 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../modules.md) / api/endpoints + +# api/endpoints + +## Contents + +- [References](endpoints.md#references) + - [DecodeVin](endpoints.md#decodevin) + - [DecodeVinExtended](endpoints.md#decodevinextended) + - [DecodeVinValues](endpoints.md#decodevinvalues) + - [DecodeVinValuesBatch](endpoints.md#decodevinvaluesbatch) + - [DecodeVinValuesExtended](endpoints.md#decodevinvaluesextended) + - [DecodeWMI](endpoints.md#decodewmi) + - [GetAllMakes](endpoints.md#getallmakes) + - [GetAllManufacturers](endpoints.md#getallmanufacturers) + - [GetCanadianVehicleSpecifications](endpoints.md#getcanadianvehiclespecifications) + - [GetEquipmentPlantCodes](endpoints.md#getequipmentplantcodes) + - [GetMakeForManufacturer](endpoints.md#getmakeformanufacturer) + - [GetMakesForManufacturerAndYear](endpoints.md#getmakesformanufacturerandyear) + - [GetMakesForVehicleType](endpoints.md#getmakesforvehicletype) + - [GetManufacturerDetails](endpoints.md#getmanufacturerdetails) + - [GetModelsForMake](endpoints.md#getmodelsformake) + - [GetModelsForMakeId](endpoints.md#getmodelsformakeid) + - [GetModelsForMakeIdYear](endpoints.md#getmodelsformakeidyear) + - [GetModelsForMakeYear](endpoints.md#getmodelsformakeyear) + - [GetParts](endpoints.md#getparts) + - [GetVehicleTypesForMake](endpoints.md#getvehicletypesformake) + - [GetVehicleTypesForMakeId](endpoints.md#getvehicletypesformakeid) + - [GetVehicleVariableList](endpoints.md#getvehiclevariablelist) + - [GetVehicleVariableValuesList](endpoints.md#getvehiclevariablevalueslist) + - [GetWMIsForManufacturer](endpoints.md#getwmisformanufacturer) + +## References + +### DecodeVin + +Re-exports [DecodeVin](endpoints/DecodeVin.md#decodevin) + +### DecodeVinExtended + +Re-exports [DecodeVinExtended](endpoints/DecodeVinExtended.md#decodevinextended) + +### DecodeVinValues + +Re-exports [DecodeVinValues](endpoints/DecodeVinValues.md#decodevinvalues) + +### DecodeVinValuesBatch + +Re-exports [DecodeVinValuesBatch](endpoints/DecodeVinValuesBatch.md#decodevinvaluesbatch) + +### DecodeVinValuesExtended + +Re-exports [DecodeVinValuesExtended](endpoints/DecodeVinValuesExtended.md#decodevinvaluesextended) + +### DecodeWMI + +Re-exports [DecodeWMI](endpoints/DecodeWMI.md#decodewmi) + +### GetAllMakes + +Re-exports [GetAllMakes](endpoints/GetAllMakes.md#getallmakes) + +### GetAllManufacturers + +Re-exports [GetAllManufacturers](endpoints/GetAllManufacturers.md#getallmanufacturers) + +### GetCanadianVehicleSpecifications + +Re-exports [GetCanadianVehicleSpecifications](endpoints/GetCanadianVehicleSpecifications.md#getcanadianvehiclespecifications) + +### GetEquipmentPlantCodes + +Re-exports [GetEquipmentPlantCodes](endpoints/GetEquipmentPlantCodes.md#getequipmentplantcodes) + +### GetMakeForManufacturer + +Re-exports [GetMakeForManufacturer](endpoints/GetMakeForManufacturer.md#getmakeformanufacturer) + +### GetMakesForManufacturerAndYear + +Re-exports [GetMakesForManufacturerAndYear](endpoints/GetMakesForManufacturerAndYear.md#getmakesformanufacturerandyear) + +### GetMakesForVehicleType + +Re-exports [GetMakesForVehicleType](endpoints/GetMakesForVehicleType.md#getmakesforvehicletype) + +### GetManufacturerDetails + +Re-exports [GetManufacturerDetails](endpoints/GetManufacturerDetails.md#getmanufacturerdetails) + +### GetModelsForMake + +Re-exports [GetModelsForMake](endpoints/GetModelsForMake.md#getmodelsformake) + +### GetModelsForMakeId + +Re-exports [GetModelsForMakeId](endpoints/GetModelsForMakeId.md#getmodelsformakeid) + +### GetModelsForMakeIdYear + +Re-exports [GetModelsForMakeIdYear](endpoints/GetModelsForMakeIdYear.md#getmodelsformakeidyear) + +### GetModelsForMakeYear + +Re-exports [GetModelsForMakeYear](endpoints/GetModelsForMakeYear.md#getmodelsformakeyear) + +### GetParts + +Re-exports [GetParts](endpoints/GetParts.md#getparts) + +### GetVehicleTypesForMake + +Re-exports [GetVehicleTypesForMake](endpoints/GetVehicleTypesForMake.md#getvehicletypesformake) + +### GetVehicleTypesForMakeId + +Re-exports [GetVehicleTypesForMakeId](endpoints/GetVehicleTypesForMakeId.md#getvehicletypesformakeid) + +### GetVehicleVariableList + +Re-exports [GetVehicleVariableList](endpoints/GetVehicleVariableList.md#getvehiclevariablelist) + +### GetVehicleVariableValuesList + +Re-exports [GetVehicleVariableValuesList](endpoints/GetVehicleVariableValuesList.md#getvehiclevariablevalueslist) + +### GetWMIsForManufacturer + +Re-exports [GetWMIsForManufacturer](endpoints/GetWMIsForManufacturer.md#getwmisformanufacturer) diff --git a/apps/docs/src/typedoc/api/endpoints/DecodeVin.md b/apps/docs/src/typedoc/api/endpoints/DecodeVin.md new file mode 100644 index 00000000..27de8d90 --- /dev/null +++ b/apps/docs/src/typedoc/api/endpoints/DecodeVin.md @@ -0,0 +1,181 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../../modules.md) / api/endpoints/DecodeVin + +# api/endpoints/DecodeVin + +## Contents + +- [Type Aliases](DecodeVin.md#type-aliases) + - [DecodeVinResults](DecodeVin.md#decodevinresults) + - [DecodeVinVariable](DecodeVin.md#decodevinvariable) +- [Functions](DecodeVin.md#functions) + - [DecodeVin()](DecodeVin.md#decodevin) + +## Type Aliases + +### DecodeVinResults + +> **DecodeVinResults**: `object` + +Objects in the `Results` array of `DecodeVin` endpoint response. + +#### Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `Value` | `string` \| `null` | - | +| `ValueId` | `string` \| `null` | - | +| `Variable` | [`DecodeVinVariable`](DecodeVin.md#decodevinvariable) | - | +| `VariableId` | `number` | - | + +#### Source + +[api/endpoints/DecodeVin.ts:110](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVin.ts#L110) + +*** + +### DecodeVinVariable + +> **DecodeVinVariable**: `"Suggested VIN"` \| `"Error Code"` \| `"Possible Values"` \| `"Additional Error Text"` \| `"Error Text"` \| `"Vehicle Descriptor"` \| `"Destination Market"` \| `"Make"` \| `"Manufacturer Name"` \| `"Model"` \| `"Model Year"` \| `"Plant City"` \| `"Series"` \| `"Trim"` \| `"Vehicle Type"` \| `"Plant Country"` \| `"Plant Company Name"` \| `"Plant State"` \| `"Trim2"` \| `"Series2"` \| `"Note"` \| `"Base Price ($)"` \| `"Non-Land Use"` \| `"Body Class"` \| `"Doors"` \| `"Windows"` \| `"Wheel Base Type"` \| `"Track Width (inches)"` \| `"Gross Vehicle Weight Rating From"` \| `"Bed Length (inches)"` \| `"Curb Weight (pounds)"` \| `"Wheel Base (inches) From"` \| `"Wheel Base (inches) To"` \| `"Gross Combination Weight Rating From"` \| `"Gross Combination Weight Rating To"` \| `"Gross Vehicle Weight Rating To"` \| `"Bed Type"` \| `"Cab Type"` \| `"Trailer Type Connection"` \| `"Trailer Body Type"` \| `"Trailer Length (feet)"` \| `"Other Trailer Info"` \| `"Number of Wheels"` \| `"Wheel Size Front (inches)"` \| `"Wheel Size Rear (inches)"` \| `"Entertainment System"` \| `"Steering Location"` \| `"Number of Seats"` \| `"Number of Seat Rows"` \| `"Transmission Style"` \| `"Transmission Speeds"` \| `"Drive Type"` \| `"Axles"` \| `"Axle Configuration"` \| `"Brake System Type"` \| `"Brake System Description"` \| `"Other Battery Info"` \| `"Battery Type"` \| `"Number of Battery Cells per Module"` \| `"Battery Current (Amps) From"` \| `"Battery Voltage (Volts) From"` \| `"Battery Energy (kWh) From"` \| `"EV Drive Unit"` \| `"Battery Current (Amps) To"` \| `"Battery Voltage (Volts) To"` \| `"Battery Energy (kWh) To"` \| `"Number of Battery Modules per Pack"` \| `"Number of Battery Packs per Vehicle"` \| `"Charger Level"` \| `"Charger Power (kW)"` \| `"Engine Number of Cylinders"` \| `"Displacement (CC)"` \| `"Displacement (CI)"` \| `"Displacement (L)"` \| `"Engine Stroke Cycles"` \| `"Engine Model"` \| `"Engine Power (kW)"` \| `"Fuel Type - Primary"` \| `"Valve Train Design"` \| `"Engine Configuration"` \| `"Fuel Type - Secondary"` \| `"Fuel Delivery / Fuel Injection Type"` \| `"Engine Brake (hp) From"` \| `"Cooling Type"` \| `"Engine Brake (hp) To"` \| `"Electrification Level"` \| `"Other Engine Info"` \| `"Turbo"` \| `"Top Speed (MPH)"` \| `"Engine Manufacturer"` \| `"Pretensioner"` \| `"Seat Belt Type"` \| `"Other Restraint System Info"` \| `"Curtain Air Bag Locations"` \| `"Seat Cushion Air Bag Locations"` \| `"Front Air Bag Locations"` \| `"Knee Air Bag Locations"` \| `"Side Air Bag Locations"` \| `"Anti-lock Braking System (ABS)"` \| `"Electronic Stability Control (ESC)"` \| `"Traction Control"` \| `"Tire Pressure Monitoring System (TPMS) Type"` \| `"Active Safety System Note"` \| `"Auto-Reverse System for Windows and Sunroofs"` \| `"Automatic Pedestrian Alerting Sound (for Hybrid and EV only)"` \| `"Event Data Recorder (EDR)"` \| `"Keyless Ignition"` \| `"SAE Automation Level From"` \| `"SAE Automation Level To"` \| `"Adaptive Cruise Control (ACC)"` \| `"Crash Imminent Braking (CIB)"` \| `"Blind Spot Warning (BSW)"` \| `"Forward Collision Warning (FCW)"` \| `"Lane Departure Warning (LDW)"` \| `"Lane Keeping Assistance (LKA)"` \| `"Backup Camera"` \| `"Parking Assist"` \| `"Bus Length (feet)"` \| `"Bus Floor Configuration Type"` \| `"Bus Type"` \| `"Other Bus Info"` \| `"Custom Motorcycle Type"` \| `"Motorcycle Suspension Type"` \| `"Motorcycle Chassis Type"` \| `"Other Motorcycle Info"` \| `"Dynamic Brake Support (DBS)"` \| `"Pedestrian Automatic Emergency Braking (PAEB)"` \| `"Automatic Crash Notification (ACN) / Advanced Automatic Crash Notification (AACN)"` \| `"Daytime Running Light (DRL)"` \| `"Headlamp Light Source"` \| `"Semiautomatic Headlamp Beam Switching"` \| `"Adaptive Driving Beam (ADB)"` \| `"Rear Cross Traffic Alert"` \| `"Rear Automatic Emergency Braking"` \| `"Blind Spot Intervention (BSI)"` \| `"Lane Centering Assistance"` \| `string` & `Record`\<`string`, `never`\> + +Possible `DecodeVinResults.Variable` values for DecodeVin endpoint. + +This type is here to provide a list of possible values manually extracted from an actual API +response. There are some things to note: +- Names are ordered to mirror actual API response order. +- Names have been known to change slightly or be added/removed. +- Some listed here could be missing from the API response. +- There may be more actual values than listed here. + +Last Updated: 02/14/2023 + +#### Source + +[api/endpoints/DecodeVin.ts:129](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVin.ts#L129) + +## Functions + +### DecodeVin() + +#### DecodeVin(vin) + +> **DecodeVin**(`vin`): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinResults`](DecodeVin.md#decodevinresults)\>\> + +::: tip :bulb: More Information +See: [DecodeVin Documentation](/api/endpoints/decode-vin) +::: + +`DecodeVin` decodes a Vehicle Identification Number (VIN) and returns useful information about +the vehicle. + +Providing `params.modelYear` allows for the decoding to specifically be done in the current, or +older (pre-1980), model year ranges. It is recommended to always provide `params.modelYear` if +the model year is known at the time of decoding, but it is not required. + +This endpoint also supports partial VIN decoding (VINs that are less than 17 characters). + - Ex: 5UXWX7C5*BA + - In this case, the VIN will be decoded partially with the available characters + - In case of partial VINs, a `*` could be used to indicate the unavailable characters + - The 9th digit is not necessary + +##### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `vin` | `string` | Vehicle Identification Number (full or partial) | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinResults`](DecodeVin.md#decodevinresults)\>\> + +- Api Response `object` +-or- url `string` if `doFetch = false` + +##### Source + +[api/endpoints/DecodeVin.ts:36](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVin.ts#L36) + +#### DecodeVin(vin, doFetch, _dummy) + +> **DecodeVin**(`vin`, `doFetch`, `_dummy`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinResults`](DecodeVin.md#decodevinresults)\>\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `vin` | `string` | +| `doFetch` | `true` | +| `_dummy`? | `undefined` | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinResults`](DecodeVin.md#decodevinresults)\>\> + +##### Source + +[api/endpoints/DecodeVin.ts:38](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVin.ts#L38) + +#### DecodeVin(vin, doFetch, _dummy) + +> **DecodeVin**(`vin`, `doFetch`, `_dummy`?): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `vin` | `string` | +| `doFetch` | `false` | +| `_dummy`? | `undefined` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/DecodeVin.ts:44](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVin.ts#L44) + +#### DecodeVin(vin, params, doFetch) + +> **DecodeVin**(`vin`, `params`, `doFetch`): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `vin` | `string` | +| `params` | `object` | +| `params.modelYear`? | `string` \| `number` | +| `doFetch` | `false` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/DecodeVin.ts:50](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVin.ts#L50) + +#### DecodeVin(vin, params, doFetch) + +> **DecodeVin**(`vin`, `params`?, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinResults`](DecodeVin.md#decodevinresults)\>\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `vin` | `string` | +| `params`? | `object` | +| `params.modelYear`? | `string` \| `number` | +| `doFetch`? | `true` | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinResults`](DecodeVin.md#decodevinresults)\>\> + +##### Source + +[api/endpoints/DecodeVin.ts:56](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVin.ts#L56) diff --git a/apps/docs/src/typedoc/api/endpoints/DecodeVinExtended.md b/apps/docs/src/typedoc/api/endpoints/DecodeVinExtended.md new file mode 100644 index 00000000..85d375f5 --- /dev/null +++ b/apps/docs/src/typedoc/api/endpoints/DecodeVinExtended.md @@ -0,0 +1,185 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../../modules.md) / api/endpoints/DecodeVinExtended + +# api/endpoints/DecodeVinExtended + +## Contents + +- [Type Aliases](DecodeVinExtended.md#type-aliases) + - [DecodeVinExtendedResults](DecodeVinExtended.md#decodevinextendedresults) + - [DecodeVinExtendedVariable](DecodeVinExtended.md#decodevinextendedvariable) +- [Functions](DecodeVinExtended.md#functions) + - [DecodeVinExtended()](DecodeVinExtended.md#decodevinextended) + +## Type Aliases + +### DecodeVinExtendedResults + +> **DecodeVinExtendedResults**: `object` + +Objects in the `Results` array of `DecodeVinExtended` endpoint response. + +#### Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `Value` | `string` \| `null` | - | +| `ValueId` | `string` \| `null` | - | +| `Variable` | [`DecodeVinExtendedVariable`](DecodeVinExtended.md#decodevinextendedvariable) | - | +| `VariableId` | `number` | - | + +#### Source + +[api/endpoints/DecodeVinExtended.ts:116](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinExtended.ts#L116) + +*** + +### DecodeVinExtendedVariable + +> **DecodeVinExtendedVariable**: `"Suggested VIN"` \| `"Error Code"` \| `"Possible Values"` \| `"Additional Error Text"` \| `"Error Text"` \| `"Vehicle Descriptor"` \| `"Destination Market"` \| `"Make"` \| `"Manufacturer Name"` \| `"Model"` \| `"Model Year"` \| `"Plant City"` \| `"Series"` \| `"Trim"` \| `"Vehicle Type"` \| `"Plant Country"` \| `"Plant Company Name"` \| `"Plant State"` \| `"Trim2"` \| `"Series2"` \| `"Note"` \| `"Base Price ($)"` \| `"Non-Land Use"` \| `"Body Class"` \| `"Doors"` \| `"Windows"` \| `"Wheel Base Type"` \| `"Track Width (inches)"` \| `"Gross Vehicle Weight Rating From"` \| `"Bed Length (inches)"` \| `"Curb Weight (pounds)"` \| `"Wheel Base (inches) From"` \| `"Wheel Base (inches) To"` \| `"Gross Combination Weight Rating From"` \| `"Gross Combination Weight Rating To"` \| `"Gross Vehicle Weight Rating To"` \| `"Bed Type"` \| `"Cab Type"` \| `"Trailer Type Connection"` \| `"Trailer Body Type"` \| `"Trailer Length (feet)"` \| `"Other Trailer Info"` \| `"Number of Wheels"` \| `"Wheel Size Front (inches)"` \| `"Wheel Size Rear (inches)"` \| `"Entertainment System"` \| `"Steering Location"` \| `"Number of Seats"` \| `"Number of Seat Rows"` \| `"Transmission Style"` \| `"Transmission Speeds"` \| `"Drive Type"` \| `"Axles"` \| `"Axle Configuration"` \| `"Brake System Type"` \| `"Brake System Description"` \| `"Other Battery Info"` \| `"Battery Type"` \| `"Number of Battery Cells per Module"` \| `"Battery Current (Amps) From"` \| `"Battery Voltage (Volts) From"` \| `"Battery Energy (kWh) From"` \| `"EV Drive Unit"` \| `"Battery Current (Amps) To"` \| `"Battery Voltage (Volts) To"` \| `"Battery Energy (kWh) To"` \| `"Number of Battery Modules per Pack"` \| `"Number of Battery Packs per Vehicle"` \| `"Charger Level"` \| `"Charger Power (kW)"` \| `"Engine Number of Cylinders"` \| `"Displacement (CC)"` \| `"Displacement (CI)"` \| `"Displacement (L)"` \| `"Engine Stroke Cycles"` \| `"Engine Model"` \| `"Engine Power (kW)"` \| `"Fuel Type - Primary"` \| `"Valve Train Design"` \| `"Engine Configuration"` \| `"Fuel Type - Secondary"` \| `"Fuel Delivery / Fuel Injection Type"` \| `"Engine Brake (hp) From"` \| `"Cooling Type"` \| `"Engine Brake (hp) To"` \| `"Electrification Level"` \| `"Other Engine Info"` \| `"Turbo"` \| `"Top Speed (MPH)"` \| `"Engine Manufacturer"` \| `"Pretensioner"` \| `"Seat Belt Type"` \| `"Other Restraint System Info"` \| `"Curtain Air Bag Locations"` \| `"Seat Cushion Air Bag Locations"` \| `"Front Air Bag Locations"` \| `"Knee Air Bag Locations"` \| `"Side Air Bag Locations"` \| `"Anti-lock Braking System (ABS)"` \| `"Electronic Stability Control (ESC)"` \| `"Traction Control"` \| `"Tire Pressure Monitoring System (TPMS) Type"` \| `"Active Safety System Note"` \| `"Auto-Reverse System for Windows and Sunroofs"` \| `"Automatic Pedestrian Alerting Sound (for Hybrid and EV only)"` \| `"Event Data Recorder (EDR)"` \| `"Keyless Ignition"` \| `"SAE Automation Level From"` \| `"SAE Automation Level To"` \| `"NCSA Body Type"` \| `"NCSA Make"` \| `"NCSA Model"` \| `"NCSA Note"` \| `"Adaptive Cruise Control (ACC)"` \| `"Crash Imminent Braking (CIB)"` \| `"Blind Spot Warning (BSW)"` \| `"Forward Collision Warning (FCW)"` \| `"Lane Departure Warning (LDW)"` \| `"Lane Keeping Assistance (LKA)"` \| `"Backup Camera"` \| `"Parking Assist"` \| `"Bus Length (feet)"` \| `"Bus Floor Configuration Type"` \| `"Bus Type"` \| `"Other Bus Info"` \| `"Custom Motorcycle Type"` \| `"Motorcycle Suspension Type"` \| `"Motorcycle Chassis Type"` \| `"Other Motorcycle Info"` \| `"Dynamic Brake Support (DBS)"` \| `"Pedestrian Automatic Emergency Braking (PAEB)"` \| `"Automatic Crash Notification (ACN) / Advanced Automatic Crash Notification (AACN)"` \| `"Daytime Running Light (DRL)"` \| `"Headlamp Light Source"` \| `"Semiautomatic Headlamp Beam Switching"` \| `"Adaptive Driving Beam (ADB)"` \| `"Rear Cross Traffic Alert"` \| `"Rear Automatic Emergency Braking"` \| `"Blind Spot Intervention (BSI)"` \| `"Lane Centering Assistance"` \| `string` & `Record`\<`string`, `never`\> + +Possible `DecodeVinExtendedResults.Variable` values for DecodeVinExtended endpoint. + +This type is here to provide a list of possible values manually extracted from an actual API +response. There are some things to note: +- Names are ordered to mirror actual API response order. +- Names have been known to change slightly or be added/removed. +- Some listed here could be missing from the API response. +- There may be more actual values than listed here. + +Last Updated: 02/14/2023 + +#### Source + +[api/endpoints/DecodeVinExtended.ts:135](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinExtended.ts#L135) + +## Functions + +### DecodeVinExtended() + +#### DecodeVinExtended(vin) + +> **DecodeVinExtended**(`vin`): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinExtendedResults`](DecodeVinExtended.md#decodevinextendedresults)\>\> + +::: tip :bulb: More Information +See: [DecodeVinExtended Documentation](/api/endpoints/decode-vin-extended) +::: + +`DecodeVinExtended` decodes a Vehicle Identification Number (VIN) and returns useful information +about the vehicle. + +This endpoint is similar to `DecodeVin` but returns additional information on variables related +to other NHTSA programs like the +[NCSA](https://www.nhtsa.gov/research-data/national-center-statistics-and-analysis-ncsa). + +Providing `params.modelYear` allows for the decoding to specifically be done in the current, or +older (pre-1980), model year ranges. It is recommended to always provide `params.modelYear` if +the model year is known at the time of decoding, but it is not required. + +This endpoint also supports partial VIN decoding (VINs that are less than 17 characters). + - Ex: 5UXWX7C5*BA + - In this case, the VIN will be decoded partially with the available characters + - In case of partial VINs, a `*` could be used to indicate the unavailable characters + - The 9th digit is not necessary + +##### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `vin` | `string` | Vehicle Identification Number (full or partial) | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinExtendedResults`](DecodeVinExtended.md#decodevinextendedresults)\>\> + +- Api Response `object` +-or- url `string` if `doFetch = false` (default: `true`) + +##### Source + +[api/endpoints/DecodeVinExtended.ts:40](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinExtended.ts#L40) + +#### DecodeVinExtended(vin, doFetch, _dummy) + +> **DecodeVinExtended**(`vin`, `doFetch`, `_dummy`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinExtendedResults`](DecodeVinExtended.md#decodevinextendedresults)\>\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `vin` | `string` | +| `doFetch` | `true` | +| `_dummy`? | `undefined` | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinExtendedResults`](DecodeVinExtended.md#decodevinextendedresults)\>\> + +##### Source + +[api/endpoints/DecodeVinExtended.ts:44](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinExtended.ts#L44) + +#### DecodeVinExtended(vin, doFetch, _dummy) + +> **DecodeVinExtended**(`vin`, `doFetch`, `_dummy`?): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `vin` | `string` | +| `doFetch` | `false` | +| `_dummy`? | `undefined` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/DecodeVinExtended.ts:50](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinExtended.ts#L50) + +#### DecodeVinExtended(vin, params, doFetch) + +> **DecodeVinExtended**(`vin`, `params`, `doFetch`): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `vin` | `string` | +| `params` | `object` | +| `params.modelYear`? | `string` \| `number` | +| `doFetch` | `false` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/DecodeVinExtended.ts:56](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinExtended.ts#L56) + +#### DecodeVinExtended(vin, params, doFetch) + +> **DecodeVinExtended**(`vin`, `params`?, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinExtendedResults`](DecodeVinExtended.md#decodevinextendedresults)\>\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `vin` | `string` | +| `params`? | `object` | +| `params.modelYear`? | `string` \| `number` | +| `doFetch`? | `true` | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinExtendedResults`](DecodeVinExtended.md#decodevinextendedresults)\>\> + +##### Source + +[api/endpoints/DecodeVinExtended.ts:62](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinExtended.ts#L62) diff --git a/apps/docs/src/typedoc/api/endpoints/DecodeVinValues.md b/apps/docs/src/typedoc/api/endpoints/DecodeVinValues.md new file mode 100644 index 00000000..0c21fe0a --- /dev/null +++ b/apps/docs/src/typedoc/api/endpoints/DecodeVinValues.md @@ -0,0 +1,325 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../../modules.md) / api/endpoints/DecodeVinValues + +# api/endpoints/DecodeVinValues + +## Contents + +- [Type Aliases](DecodeVinValues.md#type-aliases) + - [DecodeVinValuesParams](DecodeVinValues.md#decodevinvaluesparams) + - [DecodeVinValuesResults](DecodeVinValues.md#decodevinvaluesresults) +- [Functions](DecodeVinValues.md#functions) + - [DecodeVinValues()](DecodeVinValues.md#decodevinvalues) + +## Type Aliases + +### DecodeVinValuesParams + +> **DecodeVinValuesParams**: `object` + +Query String Parameters for this endpoint + +#### Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `modelYear` | `string` \| `number` | - | + +#### Source + +[api/endpoints/DecodeVinValues.ts:111](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValues.ts#L111) + +*** + +### DecodeVinValuesResults + +> **DecodeVinValuesResults**: `object` + +Single object found in the `Results` array of `DecodeVinValues` endpoint response. + +#### Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `ABS` | `string` | - | +| `ActiveSafetySysNote` | `string` | - | +| `AdaptiveCruiseControl` | `string` | - | +| `AdaptiveDrivingBeam` | `string` | - | +| `AdaptiveHeadlights` | `string` | - | +| `AdditionalErrorText` | `string` | - | +| `AirBagLocCurtain` | `string` | - | +| `AirBagLocFront` | `string` | - | +| `AirBagLocKnee` | `string` | - | +| `AirBagLocSeatCushion` | `string` | - | +| `AirBagLocSide` | `string` | - | +| `AutoReverseSystem` | `string` | - | +| `AutomaticPedestrianAlertingSound` | `string` | - | +| `AxleConfiguration` | `string` | - | +| `Axles` | `string` | - | +| `BasePrice` | `string` | - | +| `BatteryA` | `string` | - | +| `BatteryA_to` | `string` | - | +| `BatteryCells` | `string` | - | +| `BatteryInfo` | `string` | - | +| `BatteryKWh` | `string` | - | +| `BatteryKWh_to` | `string` | - | +| `BatteryModules` | `string` | - | +| `BatteryPacks` | `string` | - | +| `BatteryType` | `string` | - | +| `BatteryV` | `string` | - | +| `BatteryV_to` | `string` | - | +| `BedLengthIN` | `string` | - | +| `BedType` | `string` | - | +| `BlindSpotIntervention` | `string` | - | +| `BlindSpotMon` | `string` | - | +| `BodyCabType` | `string` | - | +| `BodyClass` | `string` | - | +| `BrakeSystemDesc` | `string` | - | +| `BrakeSystemType` | `string` | - | +| `BusFloorConfigType` | `string` | - | +| `BusLength` | `string` | - | +| `BusType` | `string` | - | +| `CAN_AACN` | `string` | - | +| `CIB` | `string` | - | +| `CashForClunkers` | `string` | - | +| `ChargerLevel` | `string` | - | +| `ChargerPowerKW` | `string` | - | +| `CoolingType` | `string` | - | +| `CurbWeightLB` | `string` | - | +| `CustomMotorcycleType` | `string` | - | +| `DaytimeRunningLight` | `string` | - | +| `DestinationMarket` | `string` | - | +| `DisplacementCC` | `string` | - | +| `DisplacementCI` | `string` | - | +| `DisplacementL` | `string` | - | +| `Doors` | `string` | - | +| `DriveType` | `string` | - | +| `DriverAssist` | `string` | - | +| `DynamicBrakeSupport` | `string` | - | +| `EDR` | `string` | - | +| `ESC` | `string` | - | +| `EVDriveUnit` | `string` | - | +| `ElectrificationLevel` | `string` | - | +| `EngineConfiguration` | `string` | - | +| `EngineCycles` | `string` | - | +| `EngineCylinders` | `string` | - | +| `EngineHP` | `string` | - | +| `EngineHP_to` | `string` | - | +| `EngineKW` | `string` | - | +| `EngineManufacturer` | `string` | - | +| `EngineModel` | `string` | - | +| `EntertainmentSystem` | `string` | - | +| `ErrorCode` | `string` | - | +| `ErrorText` | `string` | - | +| `ForwardCollisionWarning` | `string` | - | +| `FuelInjectionType` | `string` | - | +| `FuelTypePrimary` | `string` | - | +| `FuelTypeSecondary` | `string` | - | +| `GCWR` | `string` | - | +| `GCWR_to` | `string` | - | +| `GVWR` | `string` | - | +| `GVWR_to` | `string` | - | +| `KeylessIgnition` | `string` | - | +| `LaneCenteringAssistance` | `string` | - | +| `LaneDepartureWarning` | `string` | - | +| `LaneKeepSystem` | `string` | - | +| `LowerBeamHeadlampLightSource` | `string` | - | +| `Make` | `string` | - | +| `MakeID` | `string` | - | +| `Manufacturer` | `string` | - | +| `ManufacturerId` | `string` | - | +| `Model` | `string` | - | +| `ModelID` | `string` | - | +| `ModelYear` | `string` | - | +| `MotorcycleChassisType` | `string` | - | +| `MotorcycleSuspensionType` | `string` | - | +| `NCSABodyType` | `string` | - | +| `NCSAMake` | `string` | - | +| `NCSAMapExcApprovedBy` | `string` | - | +| `NCSAMapExcApprovedOn` | `string` | - | +| `NCSAMappingException` | `string` | - | +| `NCSAModel` | `string` | - | +| `NCSANote` | `string` | - | +| `NonLandUse` | `string` | - | +| `Note` | `string` | - | +| `OtherBusInfo` | `string` | - | +| `OtherEngineInfo` | `string` | - | +| `OtherMotorcycleInfo` | `string` | - | +| `OtherRestraintSystemInfo` | `string` | - | +| `OtherTrailerInfo` | `string` | - | +| `ParkAssist` | `string` | - | +| `PedestrianAutomaticEmergencyBraking` | `string` | - | +| `PlantCity` | `string` | - | +| `PlantCompanyName` | `string` | - | +| `PlantCountry` | `string` | - | +| `PlantState` | `string` | - | +| `PossibleValues` | `string` | - | +| `Pretensioner` | `string` | - | +| `RearAutomaticEmergencyBraking` | `string` | - | +| `RearCrossTrafficAlert` | `string` | - | +| `RearVisibilitySystem` | `string` | - | +| `SAEAutomationLevel` | `string` | - | +| `SAEAutomationLevel_to` | `string` | - | +| `SeatBeltsAll` | `string` | - | +| `SeatRows` | `string` | - | +| `Seats` | `string` | - | +| `SemiautomaticHeadlampBeamSwitching` | `string` | - | +| `Series` | `string` | - | +| `Series2` | `string` | - | +| `SteeringLocation` | `string` | - | +| `SuggestedVIN` | `string` | - | +| `TPMS` | `string` | - | +| `TopSpeedMPH` | `string` | - | +| `TrackWidth` | `string` | - | +| `TractionControl` | `string` | - | +| `TrailerBodyType` | `string` | - | +| `TrailerLength` | `string` | - | +| `TrailerType` | `string` | - | +| `TransmissionSpeeds` | `string` | - | +| `TransmissionStyle` | `string` | - | +| `Trim` | `string` | - | +| `Trim2` | `string` | - | +| `Turbo` | `string` | - | +| `VIN` | `string` | - | +| `ValveTrainDesign` | `string` | - | +| `VehicleDescriptor` | `string` | - | +| `VehicleType` | `string` | - | +| `WheelBaseLong` | `string` | - | +| `WheelBaseShort` | `string` | - | +| `WheelBaseType` | `string` | - | +| `WheelSizeFront` | `string` | - | +| `WheelSizeRear` | `string` | - | +| `Wheels` | `string` | - | +| `Windows` | `string` | - | + +#### Source + +[api/endpoints/DecodeVinValues.ts:118](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValues.ts#L118) + +## Functions + +### DecodeVinValues() + +#### DecodeVinValues(vin) + +> **DecodeVinValues**(`vin`): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinValuesResults`](DecodeVinValues.md#decodevinvaluesresults)\>\> + +::: tip :bulb: More Information +See: [DecodeVinValues Documentation](/api/endpoints/decode-vin-values) +::: + +`DecodeVinValues` decodes a Vehicle Identification Number (VIN) and returns useful information +about the vehicle in in a _flat format_. This means the endpoint will return an array with a +single object of results. Each key in the object is the name of a variable. + +Providing `params.modelYear` allows for the decoding to specifically be done in the current, or +older (pre-1980), model year ranges. It is recommended to always provide `params.modelYear` if +the model year is known at the time of decoding, but it is not required. + +This endpoint also supports partial VIN decoding (VINs that are less than 17 characters). + - Ex: "5UXWX7C5*BA" + - In this case, the VIN will be decoded partially with the available characters + - In case of partial VINs, a `*` could be used to indicate the unavailable characters + - The 9th digit is not necessary + +##### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `vin` | `string` | Vehicle Identification Number (full or partial) | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinValuesResults`](DecodeVinValues.md#decodevinvaluesresults)\>\> + +- Api Response `object` +-or- url `string` if `doFetch = false` + +##### Source + +[api/endpoints/DecodeVinValues.ts:37](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValues.ts#L37) + +#### DecodeVinValues(vin, doFetch, _dummy) + +> **DecodeVinValues**(`vin`, `doFetch`, `_dummy`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinValuesResults`](DecodeVinValues.md#decodevinvaluesresults)\>\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `vin` | `string` | +| `doFetch` | `true` | +| `_dummy`? | `undefined` | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinValuesResults`](DecodeVinValues.md#decodevinvaluesresults)\>\> + +##### Source + +[api/endpoints/DecodeVinValues.ts:41](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValues.ts#L41) + +#### DecodeVinValues(vin, doFetch, _dummy) + +> **DecodeVinValues**(`vin`, `doFetch`, `_dummy`?): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `vin` | `string` | +| `doFetch` | `false` | +| `_dummy`? | `undefined` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/DecodeVinValues.ts:47](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValues.ts#L47) + +#### DecodeVinValues(vin, params, doFetch) + +> **DecodeVinValues**(`vin`, `params`, `doFetch`): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `vin` | `string` | +| `params` | `object` | +| `params.modelYear`? | `string` \| `number` | +| `doFetch` | `false` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/DecodeVinValues.ts:53](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValues.ts#L53) + +#### DecodeVinValues(vin, params, doFetch) + +> **DecodeVinValues**(`vin`, `params`?, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinValuesResults`](DecodeVinValues.md#decodevinvaluesresults)\>\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `vin` | `string` | +| `params`? | `object` | +| `params.modelYear`? | `string` \| `number` | +| `doFetch`? | `true` | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinValuesResults`](DecodeVinValues.md#decodevinvaluesresults)\>\> + +##### Source + +[api/endpoints/DecodeVinValues.ts:59](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValues.ts#L59) diff --git a/apps/docs/src/typedoc/api/endpoints/DecodeVinValuesBatch.md b/apps/docs/src/typedoc/api/endpoints/DecodeVinValuesBatch.md new file mode 100644 index 00000000..bfbd533f --- /dev/null +++ b/apps/docs/src/typedoc/api/endpoints/DecodeVinValuesBatch.md @@ -0,0 +1,251 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../../modules.md) / api/endpoints/DecodeVinValuesBatch + +# api/endpoints/DecodeVinValuesBatch + +## Contents + +- [Type Aliases](DecodeVinValuesBatch.md#type-aliases) + - [DecodeVinValuesBatchResults](DecodeVinValuesBatch.md#decodevinvaluesbatchresults) +- [Functions](DecodeVinValuesBatch.md#functions) + - [DecodeVinValuesBatch()](DecodeVinValuesBatch.md#decodevinvaluesbatch) + +## Type Aliases + +### DecodeVinValuesBatchResults + +> **DecodeVinValuesBatchResults**: `object` + +Objects found in the `Results` array of `DecodeVinValuesBatch` endpoint response. + +#### Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `ABS` | `string` | - | +| `ActiveSafetySysNote` | `string` | - | +| `AdaptiveCruiseControl` | `string` | - | +| `AdaptiveDrivingBeam` | `string` | - | +| `AdaptiveHeadlights` | `string` | - | +| `AdditionalErrorText` | `string` | - | +| `AirBagLocCurtain` | `string` | - | +| `AirBagLocFront` | `string` | - | +| `AirBagLocKnee` | `string` | - | +| `AirBagLocSeatCushion` | `string` | - | +| `AirBagLocSide` | `string` | - | +| `AutoReverseSystem` | `string` | - | +| `AutomaticPedestrianAlertingSound` | `string` | - | +| `AxleConfiguration` | `string` | - | +| `Axles` | `string` | - | +| `BasePrice` | `string` | - | +| `BatteryA` | `string` | - | +| `BatteryA_to` | `string` | - | +| `BatteryCells` | `string` | - | +| `BatteryInfo` | `string` | - | +| `BatteryKWh` | `string` | - | +| `BatteryKWh_to` | `string` | - | +| `BatteryModules` | `string` | - | +| `BatteryPacks` | `string` | - | +| `BatteryType` | `string` | - | +| `BatteryV` | `string` | - | +| `BatteryV_to` | `string` | - | +| `BedLengthIN` | `string` | - | +| `BedType` | `string` | - | +| `BlindSpotIntervention` | `string` | - | +| `BlindSpotMon` | `string` | - | +| `BodyCabType` | `string` | - | +| `BodyClass` | `string` | - | +| `BrakeSystemDesc` | `string` | - | +| `BrakeSystemType` | `string` | - | +| `BusFloorConfigType` | `string` | - | +| `BusLength` | `string` | - | +| `BusType` | `string` | - | +| `CAN_AACN` | `string` | - | +| `CIB` | `string` | - | +| `CashForClunkers` | `string` | - | +| `ChargerLevel` | `string` | - | +| `ChargerPowerKW` | `string` | - | +| `CoolingType` | `string` | - | +| `CurbWeightLB` | `string` | - | +| `CustomMotorcycleType` | `string` | - | +| `DaytimeRunningLight` | `string` | - | +| `DestinationMarket` | `string` | - | +| `DisplacementCC` | `string` | - | +| `DisplacementCI` | `string` | - | +| `DisplacementL` | `string` | - | +| `Doors` | `string` | - | +| `DriveType` | `string` | - | +| `DriverAssist` | `string` | - | +| `DynamicBrakeSupport` | `string` | - | +| `EDR` | `string` | - | +| `ESC` | `string` | - | +| `EVDriveUnit` | `string` | - | +| `ElectrificationLevel` | `string` | - | +| `EngineConfiguration` | `string` | - | +| `EngineCycles` | `string` | - | +| `EngineCylinders` | `string` | - | +| `EngineHP` | `string` | - | +| `EngineHP_to` | `string` | - | +| `EngineKW` | `string` | - | +| `EngineManufacturer` | `string` | - | +| `EngineModel` | `string` | - | +| `EntertainmentSystem` | `string` | - | +| `ErrorCode` | `string` | - | +| `ErrorText` | `string` | - | +| `ForwardCollisionWarning` | `string` | - | +| `FuelInjectionType` | `string` | - | +| `FuelTypePrimary` | `string` | - | +| `FuelTypeSecondary` | `string` | - | +| `GCWR` | `string` | - | +| `GCWR_to` | `string` | - | +| `GVWR` | `string` | - | +| `GVWR_to` | `string` | - | +| `KeylessIgnition` | `string` | - | +| `LaneCenteringAssistance` | `string` | - | +| `LaneDepartureWarning` | `string` | - | +| `LaneKeepSystem` | `string` | - | +| `LowerBeamHeadlampLightSource` | `string` | - | +| `Make` | `string` | - | +| `MakeID` | `string` | - | +| `Manufacturer` | `string` | - | +| `ManufacturerId` | `string` | - | +| `Model` | `string` | - | +| `ModelID` | `string` | - | +| `ModelYear` | `string` | - | +| `MotorcycleChassisType` | `string` | - | +| `MotorcycleSuspensionType` | `string` | - | +| `NCSABodyType` | `string` | - | +| `NCSAMake` | `string` | - | +| `NCSAMapExcApprovedBy` | `string` | - | +| `NCSAMapExcApprovedOn` | `string` | - | +| `NCSAMappingException` | `string` | - | +| `NCSAModel` | `string` | - | +| `NCSANote` | `string` | - | +| `NonLandUse` | `string` | - | +| `Note` | `string` | - | +| `OtherBusInfo` | `string` | - | +| `OtherEngineInfo` | `string` | - | +| `OtherMotorcycleInfo` | `string` | - | +| `OtherRestraintSystemInfo` | `string` | - | +| `OtherTrailerInfo` | `string` | - | +| `ParkAssist` | `string` | - | +| `PedestrianAutomaticEmergencyBraking` | `string` | - | +| `PlantCity` | `string` | - | +| `PlantCompanyName` | `string` | - | +| `PlantCountry` | `string` | - | +| `PlantState` | `string` | - | +| `PossibleValues` | `string` | - | +| `Pretensioner` | `string` | - | +| `RearAutomaticEmergencyBraking` | `string` | - | +| `RearCrossTrafficAlert` | `string` | - | +| `RearVisibilitySystem` | `string` | - | +| `SAEAutomationLevel` | `string` | - | +| `SAEAutomationLevel_to` | `string` | - | +| `SeatBeltsAll` | `string` | - | +| `SeatRows` | `string` | - | +| `Seats` | `string` | - | +| `SemiautomaticHeadlampBeamSwitching` | `string` | - | +| `Series` | `string` | - | +| `Series2` | `string` | - | +| `SteeringLocation` | `string` | - | +| `SuggestedVIN` | `string` | - | +| `TPMS` | `string` | - | +| `TopSpeedMPH` | `string` | - | +| `TrackWidth` | `string` | - | +| `TractionControl` | `string` | - | +| `TrailerBodyType` | `string` | - | +| `TrailerLength` | `string` | - | +| `TrailerType` | `string` | - | +| `TransmissionSpeeds` | `string` | - | +| `TransmissionStyle` | `string` | - | +| `Trim` | `string` | - | +| `Trim2` | `string` | - | +| `Turbo` | `string` | - | +| `VIN` | `string` | - | +| `ValveTrainDesign` | `string` | - | +| `VehicleDescriptor` | `string` | - | +| `VehicleType` | `string` | - | +| `WheelBaseLong` | `string` | - | +| `WheelBaseShort` | `string` | - | +| `WheelBaseType` | `string` | - | +| `WheelSizeFront` | `string` | - | +| `WheelSizeRear` | `string` | - | +| `Wheels` | `string` | - | +| `Windows` | `string` | - | + +#### Source + +[api/endpoints/DecodeVinValuesBatch.ts:90](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValuesBatch.ts#L90) + +## Functions + +### DecodeVinValuesBatch() + +#### DecodeVinValuesBatch(inputString, doFetch) + +> **DecodeVinValuesBatch**(`inputString`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinValuesBatchResults`](DecodeVinValuesBatch.md#decodevinvaluesbatchresults)\>\> + +::: tip :bulb: More Information +See: [DecodeVinValuesBatch Documentation](/api/endpoints/decode-vin-values-batch) +::: + +`DecodeVinValuesBatch` decodes a batch of Vehicle Identification Numbers (VINs) and returns +useful information about the vehicles in in a _flat format_. This means the endpoint will return +an array with multiple objects of results. Each object represents a VIN from the `inputString` +and the key:value pairs in the objects are variables and their values for each particular VIN. + +For this particular API you just have to provide a string of VINs, `inputString`, that are +separated by a `;`. You can also indicate the model year after the vin, preceded by a `,`. + +The `inputString` parameter should be in the following format: +- ex: `5UXWX7C5*BA, 2011; 5YJSA3DS*EF` +- no modelYear: `vin; vin; vin` +- with modelYear: `vin, modelYear; vin, modelYear; vin, modelYear` +- mix of with/without modelYear: `vin; vin, modelYear` +- _vin_ and _modelYear_ are placeholders for real values in these examples +- all spaces between `;` and `,` are used in these examples for readability and are optional +- _Max 50 VINs per batch_ + +Providing the modelYear in the input string allows for the decoding to specifically be done in +the current, or older (pre-1980), model year ranges. It is recommended to always provide +the model year if it is known at the time of decoding, but it is not required. + +##### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `inputString` | `string` | A string of Vehicle Identification Numbers (full or partial)
following the format listed in the description | +| `doFetch`? | `true` | Whether to fetch the data or just return the URL
(default: `true`) | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinValuesBatchResults`](DecodeVinValuesBatch.md#decodevinvaluesbatchresults)\>\> + +- Api Response `object` +-or- url `string` if `doFetch = false` + +##### Source + +[api/endpoints/DecodeVinValuesBatch.ts:43](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValuesBatch.ts#L43) + +#### DecodeVinValuesBatch(inputString, doFetch) + +> **DecodeVinValuesBatch**(`inputString`, `doFetch`): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `inputString` | `string` | +| `doFetch` | `false` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/DecodeVinValuesBatch.ts:48](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValuesBatch.ts#L48) diff --git a/apps/docs/src/typedoc/api/endpoints/DecodeVinValuesExtended.md b/apps/docs/src/typedoc/api/endpoints/DecodeVinValuesExtended.md new file mode 100644 index 00000000..a2d0ccbc --- /dev/null +++ b/apps/docs/src/typedoc/api/endpoints/DecodeVinValuesExtended.md @@ -0,0 +1,310 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../../modules.md) / api/endpoints/DecodeVinValuesExtended + +# api/endpoints/DecodeVinValuesExtended + +## Contents + +- [Type Aliases](DecodeVinValuesExtended.md#type-aliases) + - [DecodeVinValuesExtendedResults](DecodeVinValuesExtended.md#decodevinvaluesextendedresults) +- [Functions](DecodeVinValuesExtended.md#functions) + - [DecodeVinValuesExtended()](DecodeVinValuesExtended.md#decodevinvaluesextended) + +## Type Aliases + +### DecodeVinValuesExtendedResults + +> **DecodeVinValuesExtendedResults**: `object` + +Single object found in the `Results` array of `DecodeVinValuesExtended` endpoint response. + +#### Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `ABS` | `string` | - | +| `ActiveSafetySysNote` | `string` | - | +| `AdaptiveCruiseControl` | `string` | - | +| `AdaptiveDrivingBeam` | `string` | - | +| `AdaptiveHeadlights` | `string` | - | +| `AdditionalErrorText` | `string` | - | +| `AirBagLocCurtain` | `string` | - | +| `AirBagLocFront` | `string` | - | +| `AirBagLocKnee` | `string` | - | +| `AirBagLocSeatCushion` | `string` | - | +| `AirBagLocSide` | `string` | - | +| `AutoReverseSystem` | `string` | - | +| `AutomaticPedestrianAlertingSound` | `string` | - | +| `AxleConfiguration` | `string` | - | +| `Axles` | `string` | - | +| `BasePrice` | `string` | - | +| `BatteryA` | `string` | - | +| `BatteryA_to` | `string` | - | +| `BatteryCells` | `string` | - | +| `BatteryInfo` | `string` | - | +| `BatteryKWh` | `string` | - | +| `BatteryKWh_to` | `string` | - | +| `BatteryModules` | `string` | - | +| `BatteryPacks` | `string` | - | +| `BatteryType` | `string` | - | +| `BatteryV` | `string` | - | +| `BatteryV_to` | `string` | - | +| `BedLengthIN` | `string` | - | +| `BedType` | `string` | - | +| `BlindSpotIntervention` | `string` | - | +| `BlindSpotMon` | `string` | - | +| `BodyCabType` | `string` | - | +| `BodyClass` | `string` | - | +| `BrakeSystemDesc` | `string` | - | +| `BrakeSystemType` | `string` | - | +| `BusFloorConfigType` | `string` | - | +| `BusLength` | `string` | - | +| `BusType` | `string` | - | +| `CAN_AACN` | `string` | - | +| `CIB` | `string` | - | +| `CashForClunkers` | `string` | - | +| `ChargerLevel` | `string` | - | +| `ChargerPowerKW` | `string` | - | +| `CoolingType` | `string` | - | +| `CurbWeightLB` | `string` | - | +| `CustomMotorcycleType` | `string` | - | +| `DaytimeRunningLight` | `string` | - | +| `DestinationMarket` | `string` | - | +| `DisplacementCC` | `string` | - | +| `DisplacementCI` | `string` | - | +| `DisplacementL` | `string` | - | +| `Doors` | `string` | - | +| `DriveType` | `string` | - | +| `DriverAssist` | `string` | - | +| `DynamicBrakeSupport` | `string` | - | +| `EDR` | `string` | - | +| `ESC` | `string` | - | +| `EVDriveUnit` | `string` | - | +| `ElectrificationLevel` | `string` | - | +| `EngineConfiguration` | `string` | - | +| `EngineCycles` | `string` | - | +| `EngineCylinders` | `string` | - | +| `EngineHP` | `string` | - | +| `EngineHP_to` | `string` | - | +| `EngineKW` | `string` | - | +| `EngineManufacturer` | `string` | - | +| `EngineModel` | `string` | - | +| `EntertainmentSystem` | `string` | - | +| `ErrorCode` | `string` | - | +| `ErrorText` | `string` | - | +| `ForwardCollisionWarning` | `string` | - | +| `FuelInjectionType` | `string` | - | +| `FuelTypePrimary` | `string` | - | +| `FuelTypeSecondary` | `string` | - | +| `GCWR` | `string` | - | +| `GCWR_to` | `string` | - | +| `GVWR` | `string` | - | +| `GVWR_to` | `string` | - | +| `KeylessIgnition` | `string` | - | +| `LaneCenteringAssistance` | `string` | - | +| `LaneDepartureWarning` | `string` | - | +| `LaneKeepSystem` | `string` | - | +| `LowerBeamHeadlampLightSource` | `string` | - | +| `Make` | `string` | - | +| `MakeID` | `string` | - | +| `Manufacturer` | `string` | - | +| `ManufacturerId` | `string` | - | +| `Model` | `string` | - | +| `ModelID` | `string` | - | +| `ModelYear` | `string` | - | +| `MotorcycleChassisType` | `string` | - | +| `MotorcycleSuspensionType` | `string` | - | +| `NCSABodyType` | `string` | - | +| `NCSAMake` | `string` | - | +| `NCSAMapExcApprovedBy` | `string` | - | +| `NCSAMapExcApprovedOn` | `string` | - | +| `NCSAMappingException` | `string` | - | +| `NCSAModel` | `string` | - | +| `NCSANote` | `string` | - | +| `NonLandUse` | `string` | - | +| `Note` | `string` | - | +| `OtherBusInfo` | `string` | - | +| `OtherEngineInfo` | `string` | - | +| `OtherMotorcycleInfo` | `string` | - | +| `OtherRestraintSystemInfo` | `string` | - | +| `OtherTrailerInfo` | `string` | - | +| `ParkAssist` | `string` | - | +| `PedestrianAutomaticEmergencyBraking` | `string` | - | +| `PlantCity` | `string` | - | +| `PlantCompanyName` | `string` | - | +| `PlantCountry` | `string` | - | +| `PlantState` | `string` | - | +| `PossibleValues` | `string` | - | +| `Pretensioner` | `string` | - | +| `RearAutomaticEmergencyBraking` | `string` | - | +| `RearCrossTrafficAlert` | `string` | - | +| `RearVisibilitySystem` | `string` | - | +| `SAEAutomationLevel` | `string` | - | +| `SAEAutomationLevel_to` | `string` | - | +| `SeatBeltsAll` | `string` | - | +| `SeatRows` | `string` | - | +| `Seats` | `string` | - | +| `SemiautomaticHeadlampBeamSwitching` | `string` | - | +| `Series` | `string` | - | +| `Series2` | `string` | - | +| `SteeringLocation` | `string` | - | +| `SuggestedVIN` | `string` | - | +| `TPMS` | `string` | - | +| `TopSpeedMPH` | `string` | - | +| `TrackWidth` | `string` | - | +| `TractionControl` | `string` | - | +| `TrailerBodyType` | `string` | - | +| `TrailerLength` | `string` | - | +| `TrailerType` | `string` | - | +| `TransmissionSpeeds` | `string` | - | +| `TransmissionStyle` | `string` | - | +| `Trim` | `string` | - | +| `Trim2` | `string` | - | +| `Turbo` | `string` | - | +| `VIN` | `string` | - | +| `ValveTrainDesign` | `string` | - | +| `VehicleDescriptor` | `string` | - | +| `VehicleType` | `string` | - | +| `WheelBaseLong` | `string` | - | +| `WheelBaseShort` | `string` | - | +| `WheelBaseType` | `string` | - | +| `WheelSizeFront` | `string` | - | +| `WheelSizeRear` | `string` | - | +| `Wheels` | `string` | - | +| `Windows` | `string` | - | + +#### Source + +[api/endpoints/DecodeVinValuesExtended.ts:117](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValuesExtended.ts#L117) + +## Functions + +### DecodeVinValuesExtended() + +#### DecodeVinValuesExtended(vin) + +> **DecodeVinValuesExtended**(`vin`): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinValuesExtendedResults`](DecodeVinValuesExtended.md#decodevinvaluesextendedresults)\>\> + +::: tip :bulb: More Information +See: [DecodeVinValuesExtended Documentation](/api/endpoints/decode-vin-values-extended) +::: + +`DecodeVinValuesExtended` decodes a Vehicle Identification Number (VIN) and returns useful +information about the vehicle in in a _flat format_. This means the endpoint will return an +array with a single object of results. Each key in the object is the name of a variable. + +This endpoint is similar to `DecodeVinValues` but returns additional information on variables +related to other NHTSA programs like +[NCSA](https://www.nhtsa.gov/research-data/national-center-statistics-and-analysis-ncsa), etc. + +Providing `params.modelYear` allows for the decoding to specifically be done in the current, or +older (pre-1980), model year ranges. It is recommended to always provide `params.modelYear` if +the model year is known at the time of decoding, but it is not required. + +This endpoint also supports partial VIN decoding (VINs that are less than 17 characters). + - Ex: "5UXWX7C5*BA" + - In this case, the VIN will be decoded partially with the available characters + - In case of partial VINs, a `*` could be used to indicate the unavailable characters + - The 9th digit is not necessary + +##### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `vin` | `string` | Vehicle Identification Number (full or partial) | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinValuesExtendedResults`](DecodeVinValuesExtended.md#decodevinvaluesextendedresults)\>\> + +- Api Response +`object` -or- url `string` if `doFetch = false` + +##### Source + +[api/endpoints/DecodeVinValuesExtended.ts:41](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValuesExtended.ts#L41) + +#### DecodeVinValuesExtended(vin, doFetch, _dummy) + +> **DecodeVinValuesExtended**(`vin`, `doFetch`, `_dummy`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinValuesExtendedResults`](DecodeVinValuesExtended.md#decodevinvaluesextendedresults)\>\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `vin` | `string` | +| `doFetch` | `true` | +| `_dummy`? | `undefined` | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinValuesExtendedResults`](DecodeVinValuesExtended.md#decodevinvaluesextendedresults)\>\> + +##### Source + +[api/endpoints/DecodeVinValuesExtended.ts:45](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValuesExtended.ts#L45) + +#### DecodeVinValuesExtended(vin, doFetch, _dummy) + +> **DecodeVinValuesExtended**(`vin`, `doFetch`, `_dummy`?): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `vin` | `string` | +| `doFetch` | `false` | +| `_dummy`? | `undefined` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/DecodeVinValuesExtended.ts:51](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValuesExtended.ts#L51) + +#### DecodeVinValuesExtended(vin, params, doFetch) + +> **DecodeVinValuesExtended**(`vin`, `params`, `doFetch`): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `vin` | `string` | +| `params` | `object` | +| `params.modelYear`? | `string` \| `number` | +| `doFetch` | `false` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/DecodeVinValuesExtended.ts:57](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValuesExtended.ts#L57) + +#### DecodeVinValuesExtended(vin, params, doFetch) + +> **DecodeVinValuesExtended**(`vin`, `params`?, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinValuesExtendedResults`](DecodeVinValuesExtended.md#decodevinvaluesextendedresults)\>\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `vin` | `string` | +| `params`? | `object` | +| `params.modelYear`? | `string` \| `number` | +| `doFetch`? | `true` | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinValuesExtendedResults`](DecodeVinValuesExtended.md#decodevinvaluesextendedresults)\>\> + +##### Source + +[api/endpoints/DecodeVinValuesExtended.ts:63](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValuesExtended.ts#L63) diff --git a/apps/docs/src/typedoc/api/endpoints/DecodeWMI.md b/apps/docs/src/typedoc/api/endpoints/DecodeWMI.md new file mode 100644 index 00000000..b576ded7 --- /dev/null +++ b/apps/docs/src/typedoc/api/endpoints/DecodeWMI.md @@ -0,0 +1,100 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../../modules.md) / api/endpoints/DecodeWMI + +# api/endpoints/DecodeWMI + +## Contents + +- [Type Aliases](DecodeWMI.md#type-aliases) + - [DecodeWMIResults](DecodeWMI.md#decodewmiresults) +- [Functions](DecodeWMI.md#functions) + - [DecodeWMI()](DecodeWMI.md#decodewmi) + +## Type Aliases + +### DecodeWMIResults + +> **DecodeWMIResults**: `object` + +Objects found in the `Results` array of `DecodeWMI` endpoint response. + +#### Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `CommonName` | `string` | - | +| `CreatedOn` | `string` | - | +| `DateAvailableToPublic` | `string` | - | +| `Make` | `string` | - | +| `ManufacturerName` | `string` | - | +| `ParentCompanyName` | `string` | - | +| `URL` | `string` | - | +| `UpdatedOn` | `string` \| `null` | - | +| `VehicleType` | `string` | - | + +#### Source + +[api/endpoints/DecodeWMI.ts:76](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeWMI.ts#L76) + +## Functions + +### DecodeWMI() + +#### DecodeWMI(WMI, doFetch) + +> **DecodeWMI**(`WMI`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeWMIResults`](DecodeWMI.md#decodewmiresults)\>\> + +::: tip :bulb: More Information +See: [DecodeWMI Documentation](/api/endpoints/decode-wmi) +::: + +`DecodeWMI` provides information on the World Manufacturer Identifier for a specific `WMI` code. + +`WMI` may be provided as either 3 characters representing VIN position 1-3 _or_ 6 characters +representing VIN positions 1-3 & 12-14. +- Examples: "JTD" "1T9131" + +A list of WMI codes can be found +[here](https://en.wikibooks.org/wiki/Vehicle_Identification_Numbers_(VIN_codes)/World_Manufacturer_Identifier_(WMI)), +but keep in mind that not all of the listed WMIs are registered with NHTSA and therefore may not +be available in VPIC data sets. + +##### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `WMI` | `string` | World Manufacturer Identifier | +| `doFetch`? | `true` | Whether to fetch the data or just return the URL
(default: `true`) | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeWMIResults`](DecodeWMI.md#decodewmiresults)\>\> + +- Api Response `object` +-or- url `string` if `doFetch = false` (default: `true`) + +##### Source + +[api/endpoints/DecodeWMI.ts:32](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeWMI.ts#L32) + +#### DecodeWMI(WMI, doFetch) + +> **DecodeWMI**(`WMI`, `doFetch`): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `WMI` | `string` | +| `doFetch` | `false` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/DecodeWMI.ts:37](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeWMI.ts#L37) diff --git a/apps/docs/src/typedoc/api/endpoints/GetAllMakes.md b/apps/docs/src/typedoc/api/endpoints/GetAllMakes.md new file mode 100644 index 00000000..1e7352aa --- /dev/null +++ b/apps/docs/src/typedoc/api/endpoints/GetAllMakes.md @@ -0,0 +1,86 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../../modules.md) / api/endpoints/GetAllMakes + +# api/endpoints/GetAllMakes + +## Contents + +- [Type Aliases](GetAllMakes.md#type-aliases) + - [GetAllMakesResults](GetAllMakes.md#getallmakesresults) +- [Functions](GetAllMakes.md#functions) + - [GetAllMakes()](GetAllMakes.md#getallmakes) + +## Type Aliases + +### GetAllMakesResults + +> **GetAllMakesResults**: `object` + +Objects found in the `Results` array of `GetAllMakes` endpoint response. + +#### Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `Make_ID` | `number` | - | +| `Make_Name` | `string` | - | + +#### Source + +[api/endpoints/GetAllMakes.ts:56](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetAllMakes.ts#L56) + +## Functions + +### GetAllMakes() + +#### GetAllMakes(doFetch) + +> **GetAllMakes**(`doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetAllMakesResults`](GetAllMakes.md#getallmakesresults)\>\> + +::: tip :bulb: More Information +See: [GetAllMakes Documentation](/api/endpoints/get-all-makes) +::: + +`GetAllMakes` provides a list of all the Makes available in the vPIC Dataset. +Each object in the `Results` array represents the `Make_ID` and the `Make_Name` of +an individual vehicle Make. + +- FYI there are over 10,000 registered makes in the database! + +##### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `doFetch`? | `true` | Whether to fetch the data or just return the URL
(default: `true`) | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetAllMakesResults`](GetAllMakes.md#getallmakesresults)\>\> + +- Api Response `object` +-or- url `string` if `doFetch = false` (default: `true`) + +##### Source + +[api/endpoints/GetAllMakes.ts:26](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetAllMakes.ts#L26) + +#### GetAllMakes(doFetch) + +> **GetAllMakes**(`doFetch`): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `doFetch` | `false` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/GetAllMakes.ts:28](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetAllMakes.ts#L28) diff --git a/apps/docs/src/typedoc/api/endpoints/GetAllManufacturers.md b/apps/docs/src/typedoc/api/endpoints/GetAllManufacturers.md new file mode 100644 index 00000000..8a920709 --- /dev/null +++ b/apps/docs/src/typedoc/api/endpoints/GetAllManufacturers.md @@ -0,0 +1,137 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../../modules.md) / api/endpoints/GetAllManufacturers + +# api/endpoints/GetAllManufacturers + +## Contents + +- [Type Aliases](GetAllManufacturers.md#type-aliases) + - [GetAllManufacturersResults](GetAllManufacturers.md#getallmanufacturersresults) +- [Functions](GetAllManufacturers.md#functions) + - [GetAllManufacturers()](GetAllManufacturers.md#getallmanufacturers) + +## Type Aliases + +### GetAllManufacturersResults + +> **GetAllManufacturersResults**: `object` + +Objects found in the `Results` array of `GetAllManufacturers` endpoint response. + +#### Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `Country` | `string` | - | +| `Mfr_CommonName` | `string` \| `null` | - | +| `Mfr_ID` | `number` | - | +| `Mfr_Name` | `string` | - | +| `VehicleTypes` | `object`[] | - | + +#### Source + +[api/endpoints/GetAllManufacturers.ts:111](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetAllManufacturers.ts#L111) + +## Functions + +### GetAllManufacturers() + +#### GetAllManufacturers(doFetch, _dummy) + +> **GetAllManufacturers**(`doFetch`?, `_dummy`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetAllManufacturersResults`](GetAllManufacturers.md#getallmanufacturersresults)\>\> + +::: tip :bulb: More Information +See: [GetAllManufacturers Documentation](/api/endpoints/get-all-manufacturers) +::: + +`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 + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `doFetch`? | `true` | Whether to fetch the data or just return the URL
(default: `true`) | +| `_dummy`? | `undefined` | - | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetAllManufacturersResults`](GetAllManufacturers.md#getallmanufacturersresults)\>\> + +- Api Response `object` +-or- url `string` if `doFetch = false` + +##### Source + +[api/endpoints/GetAllManufacturers.ts:33](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetAllManufacturers.ts#L33) + +#### GetAllManufacturers(doFetch, _dummy) + +> **GetAllManufacturers**(`doFetch`?, `_dummy`?): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `doFetch`? | `false` | +| `_dummy`? | `undefined` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/GetAllManufacturers.ts:38](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetAllManufacturers.ts#L38) + +#### GetAllManufacturers(params, doFetch) + +> **GetAllManufacturers**(`params`, `doFetch`): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `object` | +| `params.manufacturerType`? | `string` | +| `params.page`? | `string` \| `number` | +| `doFetch` | `false` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/GetAllManufacturers.ts:43](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetAllManufacturers.ts#L43) + +#### GetAllManufacturers(params, doFetch) + +> **GetAllManufacturers**(`params`?, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetAllManufacturersResults`](GetAllManufacturers.md#getallmanufacturersresults)\>\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params`? | `object` | +| `params.manufacturerType`? | `string` | +| `params.page`? | `string` \| `number` | +| `doFetch`? | `true` | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetAllManufacturersResults`](GetAllManufacturers.md#getallmanufacturersresults)\>\> + +##### Source + +[api/endpoints/GetAllManufacturers.ts:51](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetAllManufacturers.ts#L51) diff --git a/apps/docs/src/typedoc/api/endpoints/GetCanadianVehicleSpecifications.md b/apps/docs/src/typedoc/api/endpoints/GetCanadianVehicleSpecifications.md new file mode 100644 index 00000000..33f7fcbd --- /dev/null +++ b/apps/docs/src/typedoc/api/endpoints/GetCanadianVehicleSpecifications.md @@ -0,0 +1,108 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../../modules.md) / api/endpoints/GetCanadianVehicleSpecifications + +# api/endpoints/GetCanadianVehicleSpecifications + +## Contents + +- [Type Aliases](GetCanadianVehicleSpecifications.md#type-aliases) + - [GetCanadianVehicleSpecificationsResults](GetCanadianVehicleSpecifications.md#getcanadianvehiclespecificationsresults) +- [Functions](GetCanadianVehicleSpecifications.md#functions) + - [GetCanadianVehicleSpecifications()](GetCanadianVehicleSpecifications.md#getcanadianvehiclespecifications) + +## Type Aliases + +### GetCanadianVehicleSpecificationsResults + +> **GetCanadianVehicleSpecificationsResults**: `object` + +Objects found in the `Results` array of `GetCanadianVehicleSpecifications` endpoint response. + +#### Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `Specs` | `object`[] | - | + +#### Source + +[api/endpoints/GetCanadianVehicleSpecifications.ts:120](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetCanadianVehicleSpecifications.ts#L120) + +## Functions + +### GetCanadianVehicleSpecifications() + +#### GetCanadianVehicleSpecifications(params, doFetch) + +> **GetCanadianVehicleSpecifications**(`params`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetCanadianVehicleSpecificationsResults`](GetCanadianVehicleSpecifications.md#getcanadianvehiclespecificationsresults)\>\> + +::: tip :bulb: More Information +See: [GetCanadianVehicleSpecifications Documentation](/api/endpoints/get-canadian-vehicle-specifications) +::: + +`GetCanadianVehicleSpecifications` returns data from the Canadian Vehicle Specifications (CVS). +The CVS consists of a database of original vehicle dimensions, used primarily in +collision investigation and reconstruction, combined with a search engine. + +The CVS database is compiled annually by the Collision Investigation and Research Division of +Transport Canada. Visit official +[Canadian Vehicle Specifications](http://www.carsp.ca/research/resources/safety-sources/canadian-vehicle-specifications/) +page for more details. + +`params.year` is the only required query parameter, all others are optional but will still be +included in the query string as blank values even if not provided by the user. +See below Note for more details. + +_NOTE:_ This endpoint does not like missing query keys and will return a 404 error if any of +them are omitted from the query string. Therefore, we must set default values to empty strings +for any query keys that are not provided by the user. This means keys not provided by user will +always show up as "something=" in the query string. `year` is the only key user must provide, +no default value is set for it so that an error will be thrown if not provided by user. + +##### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `params` | `object` | Object of Query Search names and values to append to the URL as a query string | +| `params.make`? | `string` | Vehicle's make, like "Honda", "Toyota", etc... | +| `params.model`? | `string` | Vehicle's model, like "Pilot", "Focus". Can also include
some other elements like Body Type, Engine Model/size, etc... | +| `params.units`? | `string` | "Metric" (default), or "US" for standard units | +| `params.year`? | `string` \| `number` | Model year of the vehicle - year >= 1971 | +| `doFetch`? | `true` | Whether to fetch the data or just return the URL
(default: `true`) | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetCanadianVehicleSpecificationsResults`](GetCanadianVehicleSpecifications.md#getcanadianvehiclespecificationsresults)\>\> + +- Api +Response `object` -or- url `string` if `doFetch = false` + +##### Source + +[api/endpoints/GetCanadianVehicleSpecifications.ts:45](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetCanadianVehicleSpecifications.ts#L45) + +#### GetCanadianVehicleSpecifications(params, doFetch) + +> **GetCanadianVehicleSpecifications**(`params`, `doFetch`): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `object` | +| `params.make`? | `string` | +| `params.model`? | `string` | +| `params.units`? | `string` | +| `params.year` | `string` \| `number` | +| `doFetch` | `false` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/GetCanadianVehicleSpecifications.ts:55](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetCanadianVehicleSpecifications.ts#L55) diff --git a/apps/docs/src/typedoc/api/endpoints/GetEquipmentPlantCodes.md b/apps/docs/src/typedoc/api/endpoints/GetEquipmentPlantCodes.md new file mode 100644 index 00000000..e1db393b --- /dev/null +++ b/apps/docs/src/typedoc/api/endpoints/GetEquipmentPlantCodes.md @@ -0,0 +1,133 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../../modules.md) / api/endpoints/GetEquipmentPlantCodes + +# api/endpoints/GetEquipmentPlantCodes + +## Contents + +- [Type Aliases](GetEquipmentPlantCodes.md#type-aliases) + - [GetEquipmentPlantCodesParams](GetEquipmentPlantCodes.md#getequipmentplantcodesparams) + - [GetEquipmentPlantCodesResults](GetEquipmentPlantCodes.md#getequipmentplantcodesresults) +- [Functions](GetEquipmentPlantCodes.md#functions) + - [GetEquipmentPlantCodes()](GetEquipmentPlantCodes.md#getequipmentplantcodes) + +## Type Aliases + +### GetEquipmentPlantCodesParams + +> **GetEquipmentPlantCodesParams**: `object` + +Query String Parameters for this endpoint + +#### Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `equipmentType` | `"1"` \| `"3"` \| `"13"` \| `"16"` \| `1` \| `3` \| `13` \| `16` | - | +| `reportType` | `"New"` \| `"Updated"` \| `"Closed"` \| `"All"` \| `"new"` \| `"updated"` \| `"closed"` \| `"all"` | - | +| `year` | `string` \| `number` | - | + +#### Source + +[api/endpoints/GetEquipmentPlantCodes.ts:105](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetEquipmentPlantCodes.ts#L105) + +*** + +### GetEquipmentPlantCodesResults + +> **GetEquipmentPlantCodesResults**: `object` + +Objects found in the `Results` array of `GetEquipmentPlantCodes` endpoint response. + +#### Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `Address` | `string` \| `null` | - | +| `City` | `string` \| `null` | - | +| `Country` | `string` | - | +| `DOTCode` | `string` | - | +| `Name` | `string` | - | +| `OldDotCode` | `string` | - | +| `PostalCode` | `string` \| `null` | - | +| `StateProvince` | `string` \| `null` | - | +| `Status` | `string` \| `null` | - | + +#### Source + +[api/endpoints/GetEquipmentPlantCodes.ts:122](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetEquipmentPlantCodes.ts#L122) + +## Functions + +### GetEquipmentPlantCodes() + +#### GetEquipmentPlantCodes(params, doFetch) + +> **GetEquipmentPlantCodes**(`params`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetEquipmentPlantCodesResults`](GetEquipmentPlantCodes.md#getequipmentplantcodesresults)\>\> + +::: tip :bulb: More Information +See: [GetEquipmentPlantCodes Documentation](/api/endpoints/get-equipment-plant-codes) +::: + +`GetEquipmentPlantCodes` returns assigned Equipment Plant Codes. Can be filtered by Year, +Equipment Type and Report Type. + +ALL parameters are required and endpoint will return 404 if there are any undefined keys and/or +values in the query string. + +`params.equipmentType`: +- 1 (Tires) +- 3 (Brake Hoses) +- 13 (Glazing) +- 16 (Retread) + +`params.reportType`: +- 'New' (The Equipment Plant Code was assigned during the selected year) +- 'Updated' (The Equipment Plant data was modified during the selected year) +- 'Closed' (The Equipment Plant is no longer Active) +- 'All' (All Equipment Plant Codes regardless of year, including their status (active or closed)) + +`params.year`: +- year >= 2016 +- NOTE: It seems API will still respond with years `< 2016 but api docs state only years >` = 2016 + are supported + +##### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `params` | [`GetEquipmentPlantCodesParams`](GetEquipmentPlantCodes.md#getequipmentplantcodesparams) | Object of Query Search names and values to append to the URL as a query string | +| `doFetch`? | `true` | Whether to fetch the data or just return the URL
(default: `true`) | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetEquipmentPlantCodesResults`](GetEquipmentPlantCodes.md#getequipmentplantcodesresults)\>\> + +- Api Response +`object` -or- url `string` if `doFetch = false` + +##### Source + +[api/endpoints/GetEquipmentPlantCodes.ts:47](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetEquipmentPlantCodes.ts#L47) + +#### GetEquipmentPlantCodes(params, doFetch) + +> **GetEquipmentPlantCodes**(`params`, `doFetch`): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | [`GetEquipmentPlantCodesParams`](GetEquipmentPlantCodes.md#getequipmentplantcodesparams) | +| `doFetch` | `false` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/GetEquipmentPlantCodes.ts:52](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetEquipmentPlantCodes.ts#L52) diff --git a/apps/docs/src/typedoc/api/endpoints/GetMakeForManufacturer.md b/apps/docs/src/typedoc/api/endpoints/GetMakeForManufacturer.md new file mode 100644 index 00000000..7751060d --- /dev/null +++ b/apps/docs/src/typedoc/api/endpoints/GetMakeForManufacturer.md @@ -0,0 +1,93 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../../modules.md) / api/endpoints/GetMakeForManufacturer + +# api/endpoints/GetMakeForManufacturer + +## Contents + +- [Type Aliases](GetMakeForManufacturer.md#type-aliases) + - [GetMakeForManufacturerResults](GetMakeForManufacturer.md#getmakeformanufacturerresults) +- [Functions](GetMakeForManufacturer.md#functions) + - [GetMakeForManufacturer()](GetMakeForManufacturer.md#getmakeformanufacturer) + +## Type Aliases + +### GetMakeForManufacturerResults + +> **GetMakeForManufacturerResults**: `object` + +Objects found in the `Results` array of `GetMakeForManufacturer` endpoint response. + +#### Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `Make_ID` | `number` | - | +| `Make_Name` | `string` | - | +| `Mfr_Name` | `string` | - | + +#### Source + +[api/endpoints/GetMakeForManufacturer.ts:77](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetMakeForManufacturer.ts#L77) + +## Functions + +### GetMakeForManufacturer() + +#### GetMakeForManufacturer(manufacturer, doFetch) + +> **GetMakeForManufacturer**(`manufacturer`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetMakeForManufacturerResults`](GetMakeForManufacturer.md#getmakeformanufacturerresults)\>\> + +::: tip :bulb: More Information +See: [GetMakeForManufacturer Documentation](/api/endpoints/get-make-for-manufacturer) +::: + +`GetMakeForManufacturer` returns all the Makes in the vPIC dataset for a specified manufacturer +that is requested. Multiple results are returned in case of multiple matches. + +`manufacturer` name can be a partial name, or a full name for more specificity, e.g. "988", +"honda", "HONDA OF CANADA MFG., INC.", etc. + +- If supplied `manufacturer` is a number - method will do exact match on Manufacturer's Id. +- If supplied `manufacturer` is a string - it will look for manufacturers whose name is LIKE the + provided name. It accepts a partial manufacturer name as an input. + +##### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `manufacturer` | `string` \| `number` | Manufacturer Name or ID | +| `doFetch`? | `true` | Whether to fetch the data or just return the URL
(default: `true`) | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetMakeForManufacturerResults`](GetMakeForManufacturer.md#getmakeformanufacturerresults)\>\> + +- Api Response +`object` -or- url `string` if `doFetch = false` + +##### Source + +[api/endpoints/GetMakeForManufacturer.ts:31](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetMakeForManufacturer.ts#L31) + +#### GetMakeForManufacturer(manufacturer, doFetch) + +> **GetMakeForManufacturer**(`manufacturer`, `doFetch`): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `manufacturer` | `string` \| `number` | +| `doFetch` | `false` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/GetMakeForManufacturer.ts:36](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetMakeForManufacturer.ts#L36) diff --git a/apps/docs/src/typedoc/api/endpoints/GetMakesForManufacturerAndYear.md b/apps/docs/src/typedoc/api/endpoints/GetMakesForManufacturerAndYear.md new file mode 100644 index 00000000..11ad48e9 --- /dev/null +++ b/apps/docs/src/typedoc/api/endpoints/GetMakesForManufacturerAndYear.md @@ -0,0 +1,108 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../../modules.md) / api/endpoints/GetMakesForManufacturerAndYear + +# api/endpoints/GetMakesForManufacturerAndYear + +## Contents + +- [Type Aliases](GetMakesForManufacturerAndYear.md#type-aliases) + - [GetMakesForManufacturerAndYearResults](GetMakesForManufacturerAndYear.md#getmakesformanufacturerandyearresults) +- [Functions](GetMakesForManufacturerAndYear.md#functions) + - [GetMakesForManufacturerAndYear()](GetMakesForManufacturerAndYear.md#getmakesformanufacturerandyear) + +## Type Aliases + +### GetMakesForManufacturerAndYearResults + +> **GetMakesForManufacturerAndYearResults**: `object` + +Objects found in the `Results` array of `GetMakesForManufacturerAndYear` endpoint response. + +#### Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `MakeId` | `number` | - | +| `MakeName` | `string` | - | +| `MfrId` | `number` | - | +| `MfrName` | `string` | - | + +#### Source + +[api/endpoints/GetMakesForManufacturerAndYear.ts:105](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetMakesForManufacturerAndYear.ts#L105) + +## Functions + +### GetMakesForManufacturerAndYear() + +#### GetMakesForManufacturerAndYear(manufacturer, params, doFetch) + +> **GetMakesForManufacturerAndYear**(`manufacturer`, `params`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetMakesForManufacturerAndYearResults`](GetMakesForManufacturerAndYear.md#getmakesformanufacturerandyearresults)\>\> + +::: tip :bulb: More Information +See: [GetMakesForManufacturerAndYear Documentation](/api/endpoints/get-makes-for-manufacturer-and-year) +::: + +`GetMakesForManufacturerAndYear` returns all the Makes in the vPIC dataset for a specified +`manufacturer`, and whose "Year From" and "Year To" range cover the specified `year`. Multiple +results are returned in case of multiple matches. + +Both `manufacturer` and `params.year` are required. + +`manufacturer` name can be a partial name, or a full name for more specificity, e.g. "988", +"honda", "HONDA OF CANADA MFG., INC.", etc. + +- If supplied `manufacturer` is a number - method will do exact match on Manufacturer's Id. +- If supplied `manufacturer` is a string - it will look for manufacturers whose name is LIKE the + provided name. It accepts a partial manufacturer name as an input. + +`params.year` must be a number > 2016, years prior to 2016 are not supported according to the +NHTSA API. During testing it was found that the API still returns data for years prior to 2016. + +::: warning :exclamation: Required Parameters +Both `manufacturer` and `params.year` are required. + ::: + +##### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `manufacturer` | `string` \| `number` | Manufacturer Name (string) or Manufacturer ID (number) | +| `params` | `object` | Object of Query Search names and values to append to the URL as a query string | +| `params.year` | `string` \| `number` | Model year of the vehicle - Number, >= 2016 | +| `doFetch`? | `true` | Whether to fetch the data or just return the URL
(default: `true`) | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetMakesForManufacturerAndYearResults`](GetMakesForManufacturerAndYear.md#getmakesformanufacturerandyearresults)\>\> + +- Api +Response `object` -or- url `string` if `doFetch = false` + +##### Source + +[api/endpoints/GetMakesForManufacturerAndYear.ts:43](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetMakesForManufacturerAndYear.ts#L43) + +#### GetMakesForManufacturerAndYear(manufacturer, params, doFetch) + +> **GetMakesForManufacturerAndYear**(`manufacturer`, `params`, `doFetch`): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `manufacturer` | `string` \| `number` | +| `params` | `object` | +| `params.year` | `string` \| `number` | +| `doFetch` | `false` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/GetMakesForManufacturerAndYear.ts:49](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetMakesForManufacturerAndYear.ts#L49) diff --git a/apps/docs/src/typedoc/api/endpoints/GetMakesForVehicleType.md b/apps/docs/src/typedoc/api/endpoints/GetMakesForVehicleType.md new file mode 100644 index 00000000..e9f143bc --- /dev/null +++ b/apps/docs/src/typedoc/api/endpoints/GetMakesForVehicleType.md @@ -0,0 +1,90 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../../modules.md) / api/endpoints/GetMakesForVehicleType + +# api/endpoints/GetMakesForVehicleType + +## Contents + +- [Type Aliases](GetMakesForVehicleType.md#type-aliases) + - [GetMakesForVehicleTypeResults](GetMakesForVehicleType.md#getmakesforvehicletyperesults) +- [Functions](GetMakesForVehicleType.md#functions) + - [GetMakesForVehicleType()](GetMakesForVehicleType.md#getmakesforvehicletype) + +## Type Aliases + +### GetMakesForVehicleTypeResults + +> **GetMakesForVehicleTypeResults**: `object` + +Objects found in the `Results` array of `GetMakesForVehicleType` endpoint response. + +#### Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `MakeId` | `number` | - | +| `MakeName` | `string` | - | +| `VehicleTypeId` | `number` | - | +| `VehicleTypeName` | `string` | - | + +#### Source + +[api/endpoints/GetMakesForVehicleType.ts:73](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetMakesForVehicleType.ts#L73) + +## Functions + +### GetMakesForVehicleType() + +#### GetMakesForVehicleType(typeName, doFetch) + +> **GetMakesForVehicleType**(`typeName`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetMakesForVehicleTypeResults`](GetMakesForVehicleType.md#getmakesforvehicletyperesults)\>\> + +::: tip :bulb: More Information +See: [GetMakesForVehicleType Documentation](/api/endpoints/get-makes-for-vehicle-type) +::: + +`GetMakesForVehicleType` returns all the Makes in the vPIC dataset for a specified vehicle type +(`typeName`), whose name is LIKE the vehicle type name in vPIC Dataset. + +`typeName` can be a partial name, or a full name for more specificity, e.g., "Vehicle", "Moto", +"Low Speed Vehicle", etc. + +##### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `typeName` | `string` | A partial or full vehicle type name | +| `doFetch`? | `true` | Whether to fetch the data or just return the URL
(default: `true`) | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetMakesForVehicleTypeResults`](GetMakesForVehicleType.md#getmakesforvehicletyperesults)\>\> + +- Api Response +`object` -or- url `string` if `doFetch = false` + +##### Source + +[api/endpoints/GetMakesForVehicleType.ts:27](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetMakesForVehicleType.ts#L27) + +#### GetMakesForVehicleType(typeName, doFetch) + +> **GetMakesForVehicleType**(`typeName`, `doFetch`): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `typeName` | `string` | +| `doFetch` | `false` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/GetMakesForVehicleType.ts:32](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetMakesForVehicleType.ts#L32) diff --git a/apps/docs/src/typedoc/api/endpoints/GetManufacturerDetails.md b/apps/docs/src/typedoc/api/endpoints/GetManufacturerDetails.md new file mode 100644 index 00000000..6874b151 --- /dev/null +++ b/apps/docs/src/typedoc/api/endpoints/GetManufacturerDetails.md @@ -0,0 +1,115 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../../modules.md) / api/endpoints/GetManufacturerDetails + +# api/endpoints/GetManufacturerDetails + +## Contents + +- [Type Aliases](GetManufacturerDetails.md#type-aliases) + - [GetManufacturerDetailsResults](GetManufacturerDetails.md#getmanufacturerdetailsresults) +- [Functions](GetManufacturerDetails.md#functions) + - [GetManufacturerDetails()](GetManufacturerDetails.md#getmanufacturerdetails) + +## Type Aliases + +### GetManufacturerDetailsResults + +> **GetManufacturerDetailsResults**: `object` + +Objects found in the `Results` array of `GetManufacturerDetails` endpoint response. + +#### Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `Address` | `string` \| `null` | - | +| `Address2` | `string` \| `null` | - | +| `City` | `string` \| `null` | - | +| `ContactEmail` | `string` \| `null` | - | +| `ContactFax` | `string` \| `null` | - | +| `ContactPhone` | `string` \| `null` | - | +| `Country` | `string` \| `null` | - | +| `DBAs` | `string` \| `null` | - | +| `EquipmentItems` | `unknown`[] | - | +| `LastUpdated` | `string` | - | +| `ManufacturerTypes` | `object`[] | - | +| `Mfr_CommonName` | `string` \| `null` | - | +| `Mfr_ID` | `number` \| `null` | - | +| `Mfr_Name` | `string` \| `null` | - | +| `OtherManufacturerDetails` | `string` \| `null` | - | +| `PostalCode` | `string` \| `null` | - | +| `PrimaryProduct` | `string` \| `null` | - | +| `PrincipalFirstName` | `string` \| `null` | - | +| `PrincipalLastName` | `string` \| `null` | - | +| `PrincipalPosition` | `string` \| `null` | - | +| `StateProvince` | `string` \| `null` | - | +| `SubmittedName` | `string` \| `null` | - | +| `SubmittedOn` | `string` | - | +| `SubmittedPosition` | `string` \| `null` | - | +| `VehicleTypes` | `object`[] | - | + +#### Source + +[api/endpoints/GetManufacturerDetails.ts:77](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetManufacturerDetails.ts#L77) + +## Functions + +### GetManufacturerDetails() + +#### GetManufacturerDetails(manufacturer, doFetch) + +> **GetManufacturerDetails**(`manufacturer`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetManufacturerDetailsResults`](GetManufacturerDetails.md#getmanufacturerdetailsresults)\>\> + +::: tip :bulb: More Information +See: [GetMakesForVehicleType Documentation](/api/endpoints/get-makes-for-vehicle-type) +::: + +`GetManufacturerDetails` provides the details for a specific manufacturer that is requested. +Multiple results are returned in case of multiple matches. + +`manufacturer` name can be a partial name, or a full name for more specificity, e.g. "988", +"honda", "HONDA OF CANADA MFG., INC.", etc. + +- If supplied `manufacturer` is a number - method will do exact match on Manufacturer's Id. +- If supplied `manufacturer` is a string - it will look for manufacturers whose name is LIKE the + provided name. It accepts a partial manufacturer name as an input. + +##### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `manufacturer` | `string` \| `number` | Manufacturer Name or ID | +| `doFetch`? | `true` | Whether to fetch the data or just return the URL
(default: `true`) | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetManufacturerDetailsResults`](GetManufacturerDetails.md#getmanufacturerdetailsresults)\>\> + +- Api Response +`object` -or- url `string` if `doFetch = false` + +##### Source + +[api/endpoints/GetManufacturerDetails.ts:31](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetManufacturerDetails.ts#L31) + +#### GetManufacturerDetails(manufacturer, doFetch) + +> **GetManufacturerDetails**(`manufacturer`, `doFetch`): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `manufacturer` | `string` \| `number` | +| `doFetch` | `false` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/GetManufacturerDetails.ts:36](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetManufacturerDetails.ts#L36) diff --git a/apps/docs/src/typedoc/api/endpoints/GetModelsForMake.md b/apps/docs/src/typedoc/api/endpoints/GetModelsForMake.md new file mode 100644 index 00000000..2a152a71 --- /dev/null +++ b/apps/docs/src/typedoc/api/endpoints/GetModelsForMake.md @@ -0,0 +1,92 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../../modules.md) / api/endpoints/GetModelsForMake + +# api/endpoints/GetModelsForMake + +## Contents + +- [Type Aliases](GetModelsForMake.md#type-aliases) + - [GetModelsForMakeResults](GetModelsForMake.md#getmodelsformakeresults) +- [Functions](GetModelsForMake.md#functions) + - [GetModelsForMake()](GetModelsForMake.md#getmodelsformake) + +## Type Aliases + +### GetModelsForMakeResults + +> **GetModelsForMakeResults**: `object` + +Objects found in the `Results` array of `GetModelsForMake` endpoint response. + +#### Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `Make_ID` | `number` | - | +| `Make_Name` | `string` | - | +| `Model_ID` | `number` | - | +| `Model_Name` | `string` | - | + +#### Source + +[api/endpoints/GetModelsForMake.ts:71](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetModelsForMake.ts#L71) + +## Functions + +### GetModelsForMake() + +#### GetModelsForMake(makeName, doFetch) + +> **GetModelsForMake**(`makeName`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetModelsForMakeResults`](GetModelsForMake.md#getmodelsformakeresults)\>\> + +::: tip :bulb: More Information +See: [GetModelsForMake Documentation](/api/endpoints/get-models-for-make) +::: + +`GetModelsForMake` returns the Models in the vPIC dataset for a specified `makeName` +whose Name is LIKE the Make in vPIC Dataset. + +`makeName` can be a partial, or a full for more specificity, e.g., "Harley", +"Harley Davidson", etc. + +##### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `makeName` | `string` | Vehicle make name | +| `doFetch`? | `true` | Whether to fetch the data or just return the URL
(default: `true`) | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetModelsForMakeResults`](GetModelsForMake.md#getmodelsformakeresults)\>\> + +- Api Response object + +- Api Response `object` +-or- url `string` if `doFetch = false` + +##### Source + +[api/endpoints/GetModelsForMake.ts:28](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetModelsForMake.ts#L28) + +#### GetModelsForMake(makeName, doFetch) + +> **GetModelsForMake**(`makeName`, `doFetch`): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `makeName` | `string` | +| `doFetch` | `false` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/GetModelsForMake.ts:33](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetModelsForMake.ts#L33) diff --git a/apps/docs/src/typedoc/api/endpoints/GetModelsForMakeId.md b/apps/docs/src/typedoc/api/endpoints/GetModelsForMakeId.md new file mode 100644 index 00000000..58824b93 --- /dev/null +++ b/apps/docs/src/typedoc/api/endpoints/GetModelsForMakeId.md @@ -0,0 +1,104 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../../modules.md) / api/endpoints/GetModelsForMakeId + +# api/endpoints/GetModelsForMakeId + +## Contents + +- [Type Aliases](GetModelsForMakeId.md#type-aliases) + - [GetModelsForMakeIdResults](GetModelsForMakeId.md#getmodelsformakeidresults) +- [Functions](GetModelsForMakeId.md#functions) + - [GetModelsForMakeId()](GetModelsForMakeId.md#getmodelsformakeid) + +## Type Aliases + +### GetModelsForMakeIdResults + +> **GetModelsForMakeIdResults**: `object` + +Objects found in the `Results` array of `GetModelsForMakeId` endpoint response. + +#### Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `Make_ID` | `number` | - | +| `Make_Name` | `string` | - | +| `Model_ID` | `number` | - | +| `Model_Name` | `string` | - | + +#### Source + +[api/endpoints/GetModelsForMakeId.ts:87](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetModelsForMakeId.ts#L87) + +## Functions + +### GetModelsForMakeId() + +#### GetModelsForMakeId(makeId, doFetch) + +> **GetModelsForMakeId**(`makeId`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetModelsForMakeIdResults`](GetModelsForMakeId.md#getmodelsformakeidresults)\>\> + +::: tip :bulb: More Information +See: [GetModelsForMakeId Documentation](/api/endpoints/get-models-for-make-id) +::: + +`GetModelsForMakeId` returns the Models in the vPIC dataset for a specified Make whose ID is +equal to the `makeID` in the vPIC Dataset. + +You can get `makeID`s via `MAKE_ID` key in Results objects of the following endpoints: +- `GetAllMakes` endpoint +- `GetMakeForManufacturer` endpoint +- `GetModelsForMake` endpoint +- `GetModelsForMakeYear` endpoint + +You can get `makeID`s via `MakeID` key in Results objects of the following endpoints: +- `DecodeVinValues` +- `DecodeVinValuesBatch` + +You can get `makeID`s via `ValueId` key in Results objects of the following endpoints. +One of the objects in the `Results` array will contain both `Variable: "Make"` and +`VariableId: 26`. The `ValueId` key in that same object is the `makeID` for use in this +endpoint. +- `DecodeVin` +- `DecodeVinExtended` + +##### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `makeId` | `string` \| `number` | Make ID to search | +| `doFetch`? | `true` | Whether to fetch the data or just return the URL
(default: `true`) | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetModelsForMakeIdResults`](GetModelsForMakeId.md#getmodelsformakeidresults)\>\> + +- Api Response `object` +-or- url `string` if `doFetch = false` + +##### Source + +[api/endpoints/GetModelsForMakeId.ts:41](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetModelsForMakeId.ts#L41) + +#### GetModelsForMakeId(makeId, doFetch) + +> **GetModelsForMakeId**(`makeId`, `doFetch`): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `makeId` | `string` \| `number` | +| `doFetch` | `false` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/GetModelsForMakeId.ts:46](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetModelsForMakeId.ts#L46) diff --git a/apps/docs/src/typedoc/modules/api_endpoints_GetModelsForMakeIdYear.md b/apps/docs/src/typedoc/api/endpoints/GetModelsForMakeIdYear.md similarity index 56% rename from apps/docs/src/typedoc/modules/api_endpoints_GetModelsForMakeIdYear.md rename to apps/docs/src/typedoc/api/endpoints/GetModelsForMakeIdYear.md index 4e799287..cd432faf 100644 --- a/apps/docs/src/typedoc/modules/api_endpoints_GetModelsForMakeIdYear.md +++ b/apps/docs/src/typedoc/api/endpoints/GetModelsForMakeIdYear.md @@ -1,43 +1,46 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/endpoints/GetModelsForMakeIdYear +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../../index.md) \| API ) -# Module: api/endpoints/GetModelsForMakeIdYear +*** -## Table of contents +[@shaggytools/nhtsa-api-wrapper](../../modules.md) / api/endpoints/GetModelsForMakeIdYear -### Type Aliases +# api/endpoints/GetModelsForMakeIdYear -- [GetModelsForMakeIdYearResults](api_endpoints_GetModelsForMakeIdYear.md#getmodelsformakeidyearresults) +## Contents -### Functions - -- [GetModelsForMakeIdYear](api_endpoints_GetModelsForMakeIdYear.md#getmodelsformakeidyear) +- [Type Aliases](GetModelsForMakeIdYear.md#type-aliases) + - [GetModelsForMakeIdYearResults](GetModelsForMakeIdYear.md#getmodelsformakeidyearresults) +- [Functions](GetModelsForMakeIdYear.md#functions) + - [GetModelsForMakeIdYear()](GetModelsForMakeIdYear.md#getmodelsformakeidyear) ## Type Aliases ### GetModelsForMakeIdYearResults -Ƭ **GetModelsForMakeIdYearResults**: `Object` +> **GetModelsForMakeIdYearResults**: `object` Objects found in the `Results` array of `GetModelsForMakeIdYear` endpoint response. #### Type declaration -| Name | Type | -| :----------- | :------- | -| `Make_ID` | `number` | -| `Make_Name` | `string` | -| `Model_ID` | `number` | -| `Model_Name` | `string` | +| Member | Type | Description | +| :------ | :------ | :------ | +| `Make_ID` | `number` | - | +| `Make_Name` | `string` | - | +| `Model_ID` | `number` | - | +| `Model_Name` | `string` | - | -#### Defined in +#### Source [api/endpoints/GetModelsForMakeIdYear.ts:152](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetModelsForMakeIdYear.ts#L152) ## Functions -### GetModelsForMakeIdYear +### GetModelsForMakeIdYear() + +#### GetModelsForMakeIdYear(params, doFetch) -▸ **GetModelsForMakeIdYear**(`params`, `doFetch?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetModelsForMakeIdYearResults`](api_endpoints_GetModelsForMakeIdYear.md#getmodelsformakeidyearresults)\>\> +> **GetModelsForMakeIdYear**(`params`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetModelsForMakeIdYearResults`](GetModelsForMakeIdYear.md#getmodelsformakeidyearresults)\>\> ::: tip :bulb: More Information See: [GetModelsForMakeIdYear Documentation](/api/endpoints/get-models-for-make-id-year) @@ -49,21 +52,18 @@ and Make whose name is LIKE the Make in the vPIC Dataset. `params.makeId` is an integer and is **required**. A minimum of one of the following are also **required** (or a combination of both): - - `params.modelYear` year you want to search for (years >= 1995 are supported according to NHTSA docs) - `params.vehicleType` can be a partial name, or a full name for more specificity, e.g., "Vehicle", "Moto", "Low Speed Vehicle", etc. You can get `makeID`s via `MAKE_ID` key in Results objects of the following endpoints: - - `GetAllMakes` endpoint - `GetMakeForManufacturer` endpoint - `GetModelsForMake` endpoint - `GetModelsForMakeYear` endpoint You can get `makeID`s via `MakeID` key in Results objects of the following endpoints: - - `DecodeVinValues` - `DecodeVinValuesBatch` @@ -71,7 +71,6 @@ You can get `makeID`s via `ValueId` key in Results objects of the following endp One of the objects in the `Results` array will contain both `Variable: "Make"` and `VariableId: 26`. The `ValueId` key in that same object is the `makeID` for use in this endpoint. - - `DecodeVin` - `DecodeVinExtended` @@ -80,37 +79,39 @@ params are used in the query string and are instead used as part of the URL path endpoint. To account for this, we pass the params object to the `createUrl` function as the `path`, after encoding the params object key:values into a url path string. -#### Parameters +##### Parameters -| Name | Type | Description | -| :--------- | :------- | :----------------------------------------------------------------------------- | -| `params` | `Object` | Object of Query Search names and values to append to the URL as a query string | -| `doFetch?` | `true` | Whether to fetch the data or just return the URL (default: `true`) | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `params` | `Object` | Object of Query Search names and values to append to the URL as a query string | +| `doFetch`? | `true` | Whether to fetch the data or just return the URL
(default: `true`) | -#### Returns +##### Returns -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetModelsForMakeIdYearResults`](api_endpoints_GetModelsForMakeIdYear.md#getmodelsformakeidyearresults)\>\> +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetModelsForMakeIdYearResults`](GetModelsForMakeIdYear.md#getmodelsformakeidyearresults)\>\> - Api Response - `object` -or- url `string` if `doFetch = false` +`object` -or- url `string` if `doFetch = false` -#### Defined in +##### Source [api/endpoints/GetModelsForMakeIdYear.ts:61](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetModelsForMakeIdYear.ts#L61) -▸ **GetModelsForMakeIdYear**(`params`, `doFetch`): `Promise`<`string`\> +#### GetModelsForMakeIdYear(params, doFetch) + +> **GetModelsForMakeIdYear**(`params`, `doFetch`): `Promise`\<`string`\> -#### Parameters +##### Parameters -| Name | Type | -| :-------- | :------- | -| `params` | `Object` | -| `doFetch` | `false` | +| Parameter | Type | +| :------ | :------ | +| `params` | `Object` | +| `doFetch` | `false` | -#### Returns +##### Returns -`Promise`<`string`\> +`Promise`\<`string`\> -#### Defined in +##### Source [api/endpoints/GetModelsForMakeIdYear.ts:71](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetModelsForMakeIdYear.ts#L71) diff --git a/apps/docs/src/typedoc/modules/api_endpoints_GetModelsForMakeYear.md b/apps/docs/src/typedoc/api/endpoints/GetModelsForMakeYear.md similarity index 50% rename from apps/docs/src/typedoc/modules/api_endpoints_GetModelsForMakeYear.md rename to apps/docs/src/typedoc/api/endpoints/GetModelsForMakeYear.md index e0c01795..f1d87357 100644 --- a/apps/docs/src/typedoc/modules/api_endpoints_GetModelsForMakeYear.md +++ b/apps/docs/src/typedoc/api/endpoints/GetModelsForMakeYear.md @@ -1,43 +1,46 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/endpoints/GetModelsForMakeYear +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../../index.md) \| API ) -# Module: api/endpoints/GetModelsForMakeYear +*** -## Table of contents +[@shaggytools/nhtsa-api-wrapper](../../modules.md) / api/endpoints/GetModelsForMakeYear -### Type Aliases +# api/endpoints/GetModelsForMakeYear -- [GetModelsForMakeYearResults](api_endpoints_GetModelsForMakeYear.md#getmodelsformakeyearresults) +## Contents -### Functions - -- [GetModelsForMakeYear](api_endpoints_GetModelsForMakeYear.md#getmodelsformakeyear) +- [Type Aliases](GetModelsForMakeYear.md#type-aliases) + - [GetModelsForMakeYearResults](GetModelsForMakeYear.md#getmodelsformakeyearresults) +- [Functions](GetModelsForMakeYear.md#functions) + - [GetModelsForMakeYear()](GetModelsForMakeYear.md#getmodelsformakeyear) ## Type Aliases ### GetModelsForMakeYearResults -Ƭ **GetModelsForMakeYearResults**: `Object` +> **GetModelsForMakeYearResults**: `object` Objects found in the `Results` array of `GetModelsForMakeYear` endpoint response. #### Type declaration -| Name | Type | -| :----------- | :------- | -| `Make_ID` | `number` | -| `Make_Name` | `string` | -| `Model_ID` | `number` | -| `Model_Name` | `string` | +| Member | Type | Description | +| :------ | :------ | :------ | +| `Make_ID` | `number` | - | +| `Make_Name` | `string` | - | +| `Model_ID` | `number` | - | +| `Model_Name` | `string` | - | -#### Defined in +#### Source [api/endpoints/GetModelsForMakeYear.ts:133](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetModelsForMakeYear.ts#L133) ## Functions -### GetModelsForMakeYear +### GetModelsForMakeYear() + +#### GetModelsForMakeYear(params, doFetch) -▸ **GetModelsForMakeYear**(`params`, `doFetch?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetModelsForMakeYearResults`](api_endpoints_GetModelsForMakeYear.md#getmodelsformakeyearresults)\>\> +> **GetModelsForMakeYear**(`params`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetModelsForMakeYearResults`](GetModelsForMakeYear.md#getmodelsformakeyearresults)\>\> ::: tip :bulb: More Information See: [GetModelsForMakeYear Documentation](/api/endpoints/get-models-for-make-year) @@ -50,7 +53,6 @@ Make whose name is LIKE the Make in the vPIC Dataset. "Harley", "Harley Davidson", etc. A minimum of one of the following are also **required** (or a combination of both): - - `params.modelYear` year you want to search for (years >= 1995 are supported according to NHTSA docs) - `params.vehicleType` can be a partial name, or a full name for more specificity, e.g., @@ -61,37 +63,39 @@ params are used in the query string and are instead used as part of the URL path endpoint. To account for this, we pass the params object to the `createUrl` function as the `path`, after encoding the params object key:values into a url path string. -#### Parameters +##### Parameters -| Name | Type | Description | -| :--------- | :------- | :----------------------------------------------------------------------------- | -| `params` | `Object` | Object of Query Search names and values to append to the URL as a query string | -| `doFetch?` | `true` | Whether to fetch the data or just return the URL (default: `true`) | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `params` | `Object` | Object of Query Search names and values to append to the URL as a query string | +| `doFetch`? | `true` | Whether to fetch the data or just return the URL
(default: `true`) | -#### Returns +##### Returns -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetModelsForMakeYearResults`](api_endpoints_GetModelsForMakeYear.md#getmodelsformakeyearresults)\>\> +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetModelsForMakeYearResults`](GetModelsForMakeYear.md#getmodelsformakeyearresults)\>\> - Api Response `object` - -or- url `string` if `doFetch = false` +-or- url `string` if `doFetch = false` -#### Defined in +##### Source [api/endpoints/GetModelsForMakeYear.ts:47](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetModelsForMakeYear.ts#L47) -▸ **GetModelsForMakeYear**(`params`, `doFetch`): `Promise`<`string`\> +#### GetModelsForMakeYear(params, doFetch) + +> **GetModelsForMakeYear**(`params`, `doFetch`): `Promise`\<`string`\> -#### Parameters +##### Parameters -| Name | Type | -| :-------- | :------- | -| `params` | `Object` | -| `doFetch` | `false` | +| Parameter | Type | +| :------ | :------ | +| `params` | `Object` | +| `doFetch` | `false` | -#### Returns +##### Returns -`Promise`<`string`\> +`Promise`\<`string`\> -#### Defined in +##### Source [api/endpoints/GetModelsForMakeYear.ts:57](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetModelsForMakeYear.ts#L57) diff --git a/apps/docs/src/typedoc/api/endpoints/GetParts.md b/apps/docs/src/typedoc/api/endpoints/GetParts.md new file mode 100644 index 00000000..95a62555 --- /dev/null +++ b/apps/docs/src/typedoc/api/endpoints/GetParts.md @@ -0,0 +1,167 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../../modules.md) / api/endpoints/GetParts + +# api/endpoints/GetParts + +## Contents + +- [Type Aliases](GetParts.md#type-aliases) + - [GetPartsResults](GetParts.md#getpartsresults) +- [Functions](GetParts.md#functions) + - [GetParts()](GetParts.md#getparts) + +## Type Aliases + +### GetPartsResults + +> **GetPartsResults**: `object` + +Objects found in the `Results` array of `GetParts` endpoint response. + +#### Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `CoverLetterURL` | `string` | - | +| `LetterDate` | `string` | - | +| `ManufacturerId` | `number` | - | +| `ManufacturerName` | `string` | - | +| `ModelYearFrom` | `number` \| `null` | - | +| `ModelYearTo` | `number` \| `null` | - | +| `Name` | `string` | - | +| `Type` | `string` | - | +| `URL` | `string` | - | + +#### Source + +[api/endpoints/GetParts.ts:143](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetParts.ts#L143) + +## Functions + +### GetParts() + +#### GetParts(doFetch, _dummy) + +> **GetParts**(`doFetch`?, `_dummy`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetPartsResults`](GetParts.md#getpartsresults)\>\> + +::: tip :bulb: More Information +See: [GetParts Documentation](/api/endpoints/get-parts) +::: + +`GetParts` provides a list of ORGs with letter date in the given range of the dates and with +specified Type (`params.type`) of ORG. + +- Up to 1000 results will be returned at a time. +- Get the next page by incrementing the `params.page` query parameter. + +All query `params` are optional. + +`params.manufacturer`: +- (optional) if supplied value is a number - method will do exact match on Manufacturer's Id +- if supplied value is a string - it will look for manufacturers whose name is LIKE the provided + name +- it accepts a partial manufacturer name as an input +- multiple results are returned in case of multiple matches +- manufacturer name can be a partial name, or a full name for more specificity, e.g., "988", + "HONDA", "HONDA OF CANADA MFG., INC.", etc. + +`params.type`: +- (optional) number, 565 (Vehicle Identification Number Guidance, based on 49 CFR Part 565) + or 566 (Manufacturer Identification – Reporting Requirements based on 49 CFR Part 566) + +`params.fromDate`: +- (optional) ORG's Letter Date should be on or after this date + +`params.toDate`: +- (optional) ORG's Letter Date should be on or before this date + +`params.page`: + - (optional) number, 1 (default) first 1000 records, 2 - next 1000 records, etc + +##### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `doFetch`? | `true` | Whether to fetch the data or just return the URL
(default: `true`) | +| `_dummy`? | `undefined` | - | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetPartsResults`](GetParts.md#getpartsresults)\>\> + +- Api Response `object` +-or- url `string` if `doFetch = false` + +##### Source + +[api/endpoints/GetParts.ts:60](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetParts.ts#L60) + +#### GetParts(doFetch, _dummy) + +> **GetParts**(`doFetch`?, `_dummy`?): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `doFetch`? | `false` | +| `_dummy`? | `undefined` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/GetParts.ts:65](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetParts.ts#L65) + +#### GetParts(params, doFetch) + +> **GetParts**(`params`, `doFetch`): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | `object` | +| `params.fromDate`? | `string` | +| `params.manufacturer`? | `string` \| `number` | +| `params.page`? | `string` \| `number` | +| `params.toDate`? | `string` | +| `params.type`? | `565` \| `566` | +| `doFetch` | `false` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/GetParts.ts:67](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetParts.ts#L67) + +#### GetParts(params, doFetch) + +> **GetParts**(`params`?, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetPartsResults`](GetParts.md#getpartsresults)\>\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params`? | `object` | +| `params.fromDate`? | `string` | +| `params.manufacturer`? | `string` \| `number` | +| `params.page`? | `string` \| `number` | +| `params.toDate`? | `string` | +| `params.type`? | `565` \| `566` | +| `doFetch`? | `true` | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetPartsResults`](GetParts.md#getpartsresults)\>\> + +##### Source + +[api/endpoints/GetParts.ts:78](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetParts.ts#L78) diff --git a/apps/docs/src/typedoc/api/endpoints/GetVehicleTypesForMake.md b/apps/docs/src/typedoc/api/endpoints/GetVehicleTypesForMake.md new file mode 100644 index 00000000..44160e05 --- /dev/null +++ b/apps/docs/src/typedoc/api/endpoints/GetVehicleTypesForMake.md @@ -0,0 +1,90 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../../modules.md) / api/endpoints/GetVehicleTypesForMake + +# api/endpoints/GetVehicleTypesForMake + +## Contents + +- [Type Aliases](GetVehicleTypesForMake.md#type-aliases) + - [GetVehicleTypesForMakeResults](GetVehicleTypesForMake.md#getvehicletypesformakeresults) +- [Functions](GetVehicleTypesForMake.md#functions) + - [GetVehicleTypesForMake()](GetVehicleTypesForMake.md#getvehicletypesformake) + +## Type Aliases + +### GetVehicleTypesForMakeResults + +> **GetVehicleTypesForMakeResults**: `object` + +Objects found in the `Results` array of `GetVehicleTypesForMake` endpoint response. + +#### Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `MakeId` | `number` | - | +| `MakeName` | `string` | - | +| `VehicleTypeId` | `number` | - | +| `VehicleTypeName` | `string` | - | + +#### Source + +[api/endpoints/GetVehicleTypesForMake.ts:73](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetVehicleTypesForMake.ts#L73) + +## Functions + +### GetVehicleTypesForMake() + +#### GetVehicleTypesForMake(makeName, doFetch) + +> **GetVehicleTypesForMake**(`makeName`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetVehicleTypesForMakeResults`](GetVehicleTypesForMake.md#getvehicletypesformakeresults)\>\> + +::: tip :bulb: More Information +See: [GetVehicleTypesForMake Documentation](/api/endpoints/get-vehicle-types-for-make) +::: + +`GetVehicleTypesForMake` returns all the Vehicle Types in the vPIC dataset for a specified Make, +whose name is LIKE the make name in the vPIC Dataset. + +`makeName` can be a partial name, or a full name for more specificity, e.g., "Merc", +"Mercedes Benz", etc. + +##### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `makeName` | `string` | Name of the vehicle make to search | +| `doFetch`? | `true` | Whether to fetch the data or just return the URL
(default: `true`) | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetVehicleTypesForMakeResults`](GetVehicleTypesForMake.md#getvehicletypesformakeresults)\>\> + +- Api Response +`object` -or- url `string` if `doFetch = false` + +##### Source + +[api/endpoints/GetVehicleTypesForMake.ts:27](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetVehicleTypesForMake.ts#L27) + +#### GetVehicleTypesForMake(makeName, doFetch) + +> **GetVehicleTypesForMake**(`makeName`, `doFetch`): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `makeName` | `string` | +| `doFetch` | `false` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/GetVehicleTypesForMake.ts:32](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetVehicleTypesForMake.ts#L32) diff --git a/apps/docs/src/typedoc/api/endpoints/GetVehicleTypesForMakeId.md b/apps/docs/src/typedoc/api/endpoints/GetVehicleTypesForMakeId.md new file mode 100644 index 00000000..0ef1a8a9 --- /dev/null +++ b/apps/docs/src/typedoc/api/endpoints/GetVehicleTypesForMakeId.md @@ -0,0 +1,102 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../../modules.md) / api/endpoints/GetVehicleTypesForMakeId + +# api/endpoints/GetVehicleTypesForMakeId + +## Contents + +- [Type Aliases](GetVehicleTypesForMakeId.md#type-aliases) + - [GetVehicleTypesForMakeIdResults](GetVehicleTypesForMakeId.md#getvehicletypesformakeidresults) +- [Functions](GetVehicleTypesForMakeId.md#functions) + - [GetVehicleTypesForMakeId()](GetVehicleTypesForMakeId.md#getvehicletypesformakeid) + +## Type Aliases + +### GetVehicleTypesForMakeIdResults + +> **GetVehicleTypesForMakeIdResults**: `object` + +Objects found in the `Results` array of `GetVehicleTypesForMakeId` endpoint response. + +#### Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `VehicleTypeId` | `number` | - | +| `VehicleTypeName` | `string` | - | + +#### Source + +[api/endpoints/GetVehicleTypesForMakeId.ts:87](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetVehicleTypesForMakeId.ts#L87) + +## Functions + +### GetVehicleTypesForMakeId() + +#### GetVehicleTypesForMakeId(makeId, doFetch) + +> **GetVehicleTypesForMakeId**(`makeId`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetVehicleTypesForMakeIdResults`](GetVehicleTypesForMakeId.md#getvehicletypesformakeidresults)\>\> + +::: tip :bulb: More Information +See: [GetVehicleTypesForMakeId Documentation](/api/endpoints/get-vehicle-types-for-make-id) +::: + +`GetVehicleTypesForMakeId` returns the Models in the vPIC dataset for a specified Make +whose ID is equal to the `makeID` in the vPIC Dataset. + +You can get `makeID`s via `MAKE_ID` key in Results objects of the following endpoints: +- `GetAllMakes` endpoint +- `GetMakeForManufacturer` endpoint +- `GetModelsForMake` endpoint +- `GetModelsForMakeYear` endpoint + +You can get `makeID`s via `MakeID` key in Results objects of the following endpoints: +- `DecodeVinValues` +- `DecodeVinValuesBatch` + +You can get `makeID`s via `ValueId` key in Results objects of the following endpoints. +One of the objects in the `Results` array will contain both `Variable: "Make"` and +`VariableId: 26`. The `ValueId` key in that same object is the `makeID` for use in this +endpoint. +- `DecodeVin` +- `DecodeVinExtended` + +##### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `makeId` | `string` \| `number` | Make ID to search | +| `doFetch`? | `true` | Whether to fetch the data or just return the URL
(default: `true`) | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetVehicleTypesForMakeIdResults`](GetVehicleTypesForMakeId.md#getvehicletypesformakeidresults)\>\> + +- Api Response +`object` -or- url `string` if `doFetch = false` + +##### Source + +[api/endpoints/GetVehicleTypesForMakeId.ts:41](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetVehicleTypesForMakeId.ts#L41) + +#### GetVehicleTypesForMakeId(makeId, doFetch) + +> **GetVehicleTypesForMakeId**(`makeId`, `doFetch`): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `makeId` | `string` \| `number` | +| `doFetch` | `false` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/GetVehicleTypesForMakeId.ts:46](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetVehicleTypesForMakeId.ts#L46) diff --git a/apps/docs/src/typedoc/api/endpoints/GetVehicleVariableList.md b/apps/docs/src/typedoc/api/endpoints/GetVehicleVariableList.md new file mode 100644 index 00000000..badbffa6 --- /dev/null +++ b/apps/docs/src/typedoc/api/endpoints/GetVehicleVariableList.md @@ -0,0 +1,86 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../../modules.md) / api/endpoints/GetVehicleVariableList + +# api/endpoints/GetVehicleVariableList + +## Contents + +- [Type Aliases](GetVehicleVariableList.md#type-aliases) + - [GetVehicleVariableListResults](GetVehicleVariableList.md#getvehiclevariablelistresults) +- [Functions](GetVehicleVariableList.md#functions) + - [GetVehicleVariableList()](GetVehicleVariableList.md#getvehiclevariablelist) + +## Type Aliases + +### GetVehicleVariableListResults + +> **GetVehicleVariableListResults**: `object` + +Objects found in the `Results` array of `GetVehicleVariableList` endpoint response. + +#### Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `DataType` | `"string"` \| `"int"` \| `"decimal"` \| `"lookup"` | - | +| `Description` | `string` | - | +| `GroupName` | `string` \| `null` | - | +| `ID` | `number` | - | +| `Name` | `string` | - | + +#### Source + +[api/endpoints/GetVehicleVariableList.ts:54](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetVehicleVariableList.ts#L54) + +## Functions + +### GetVehicleVariableList() + +#### GetVehicleVariableList(doFetch) + +> **GetVehicleVariableList**(`doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetVehicleVariableListResults`](GetVehicleVariableList.md#getvehiclevariablelistresults)\>\> + +::: tip :bulb: More Information +See: [GetVehicleVariableList Documentation](/api/endpoints/get-vehicle-variable-list) +::: + +`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 + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `doFetch`? | `true` | Whether to fetch the data or just return the URL
(default: `true`) | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetVehicleVariableListResults`](GetVehicleVariableList.md#getvehiclevariablelistresults)\>\> + +- Api Response +`object` -or- url `string` if `doFetch = false` + +##### Source + +[api/endpoints/GetVehicleVariableList.ts:23](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetVehicleVariableList.ts#L23) + +#### GetVehicleVariableList(doFetch) + +> **GetVehicleVariableList**(`doFetch`): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `doFetch` | `false` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/GetVehicleVariableList.ts:27](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetVehicleVariableList.ts#L27) diff --git a/apps/docs/src/typedoc/api/endpoints/GetVehicleVariableValuesList.md b/apps/docs/src/typedoc/api/endpoints/GetVehicleVariableValuesList.md new file mode 100644 index 00000000..ff730409 --- /dev/null +++ b/apps/docs/src/typedoc/api/endpoints/GetVehicleVariableValuesList.md @@ -0,0 +1,91 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../../modules.md) / api/endpoints/GetVehicleVariableValuesList + +# api/endpoints/GetVehicleVariableValuesList + +## Contents + +- [Type Aliases](GetVehicleVariableValuesList.md#type-aliases) + - [GetVehicleVariableValuesListResults](GetVehicleVariableValuesList.md#getvehiclevariablevalueslistresults) +- [Functions](GetVehicleVariableValuesList.md#functions) + - [GetVehicleVariableValuesList()](GetVehicleVariableValuesList.md#getvehiclevariablevalueslist) + +## Type Aliases + +### GetVehicleVariableValuesListResults + +> **GetVehicleVariableValuesListResults**: `object` + +Objects found in the `Results` array of `GetVehicleVariableValuesList` endpoint response. + +#### Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `ElementName` | `string` | - | +| `Id` | `number` | - | +| `Name` | `string` | - | + +#### Source + +[api/endpoints/GetVehicleVariableValuesList.ts:75](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetVehicleVariableValuesList.ts#L75) + +## Functions + +### GetVehicleVariableValuesList() + +#### GetVehicleVariableValuesList(variableValue, doFetch) + +> **GetVehicleVariableValuesList**(`variableValue`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetVehicleVariableValuesListResults`](GetVehicleVariableValuesList.md#getvehiclevariablevalueslistresults)\>\> + +::: tip :bulb: More Information +See: [GetVehicleVariableValuesList Documentation](/api/endpoints/get-vehicle-variable-values-list) +::: + +`GetVehicleVariableValuesList` provides a list of all the accepted values for a given variable +that are stored in the vPIC dataset. + +If `variableValue` is a string, it must use full name, not just part of it, e.g., +"Battery Type", not "Battery" + +`variableValue` can be also be a number, which is the ID of the variable, e.g., 1, 2, 3, etc. + +##### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `variableValue` | `string` \| `number` | The variable you want to get a values list of | +| `doFetch`? | `true` | Whether to fetch the data or just return the URL
(default: `true`) | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetVehicleVariableValuesListResults`](GetVehicleVariableValuesList.md#getvehiclevariablevalueslistresults)\>\> + +- Api Response +`object` -or- url `string` if `doFetch = false` + +##### Source + +[api/endpoints/GetVehicleVariableValuesList.ts:29](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetVehicleVariableValuesList.ts#L29) + +#### GetVehicleVariableValuesList(variableValue, doFetch) + +> **GetVehicleVariableValuesList**(`variableValue`, `doFetch`): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `variableValue` | `string` \| `number` | +| `doFetch` | `false` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/GetVehicleVariableValuesList.ts:34](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetVehicleVariableValuesList.ts#L34) diff --git a/apps/docs/src/typedoc/api/endpoints/GetWMIsForManufacturer.md b/apps/docs/src/typedoc/api/endpoints/GetWMIsForManufacturer.md new file mode 100644 index 00000000..045861b4 --- /dev/null +++ b/apps/docs/src/typedoc/api/endpoints/GetWMIsForManufacturer.md @@ -0,0 +1,111 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../../modules.md) / api/endpoints/GetWMIsForManufacturer + +# api/endpoints/GetWMIsForManufacturer + +## Contents + +- [Type Aliases](GetWMIsForManufacturer.md#type-aliases) + - [GetWMIsForManufacturerResults](GetWMIsForManufacturer.md#getwmisformanufacturerresults) +- [Functions](GetWMIsForManufacturer.md#functions) + - [GetWMIsForManufacturer()](GetWMIsForManufacturer.md#getwmisformanufacturer) + +## Type Aliases + +### GetWMIsForManufacturerResults + +> **GetWMIsForManufacturerResults**: `object` + +Objects found in the `Results` array of `GetWMIsForManufacturer` endpoint response. + +#### Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `Country` | `string` \| `null` | - | +| `CreatedOn` | `string` | - | +| `DateAvailableToPublic` | `string` | - | +| `Id` | `number` | - | +| `Name` | `string` | - | +| `UpdatedOn` | `string` | - | +| `VehicleType` | `string` | - | +| `WMI` | `string` | - | + +#### Source + +[api/endpoints/GetWMIsForManufacturer.ts:123](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetWMIsForManufacturer.ts#L123) + +## Functions + +### GetWMIsForManufacturer() + +#### GetWMIsForManufacturer(params, doFetch) + +> **GetWMIsForManufacturer**(`params`?, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetWMIsForManufacturerResults`](GetWMIsForManufacturer.md#getwmisformanufacturerresults)\>\> + +::: tip :bulb: More Information +See: [GetWMIsForManufacturer Documentation](/api/endpoints/get-wmis-for-manufacturer) +::: + +`GetWMIsForManufacturer` provides information on the World Manufacturer Identifier (WMI) for a +specified `manufacturer`. Only WMIs registered in vPICList are displayed. Multiple results are +returned in case of multiple matches. + +Both `manufacturer` and `vehicleType` are optional but at least one must be provided. + +`manufacturer` can be a partial name, or a full name for more specificity, or WMI ID number, + e.g., "Merc", "Mercedes Benz", 987, etc. +- If `manufacturer` is a number - method will do exact match on Manufacturer's Id +- If `manufacturer` is a string - it will look for manufacturers whose name is LIKE the provided + name (it accepts a partial Manufacturer name as an input) + +`vehicleType` can be a string or number, e.g., "car", 1, etc. +- If `vehicleType` is a number - method will do exact match on VehicleType's Id +- If `vehicleType` is a string - it will look for VehicleType whose name is LIKE the provided + name (it accepts a partial VehicleType name as an input). + +_NOTE_: For this endpoint, `manufacturer` is actually part of the path string, not a query param. +We include `manufacturer` in params as it's easier to type the function args using the +'AtLeastOne' type if they are placed in the same object (params). This can cause confusion as +it's not consistent with other endpoint methods where path string is the first arg, and the query +params are the second arg. + +##### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `params`? | [`AtLeastOne`](../../utils/types.md#atleastonet-r)\<`object`\> | Object of Query Search names and values to append to the URL as a query string | +| `doFetch`? | `true` | Whether to fetch the data or just return the URL
(default: `true`) | + +##### Returns + +`Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetWMIsForManufacturerResults`](GetWMIsForManufacturer.md#getwmisformanufacturerresults)\>\> + +- Api Response +`object` -or- url `string` if `doFetch = false` + +##### Source + +[api/endpoints/GetWMIsForManufacturer.ts:48](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetWMIsForManufacturer.ts#L48) + +#### GetWMIsForManufacturer(params, doFetch) + +> **GetWMIsForManufacturer**(`params`, `doFetch`): `Promise`\<`string`\> + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `params` | [`AtLeastOne`](../../utils/types.md#atleastonet-r)\<`object`\> | +| `doFetch` | `false` | + +##### Returns + +`Promise`\<`string`\> + +##### Source + +[api/endpoints/GetWMIsForManufacturer.ts:56](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetWMIsForManufacturer.ts#L56) diff --git a/apps/docs/src/typedoc/api/endpoints/types.md b/apps/docs/src/typedoc/api/endpoints/types.md new file mode 100644 index 00000000..fa00b9de --- /dev/null +++ b/apps/docs/src/typedoc/api/endpoints/types.md @@ -0,0 +1,148 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../../modules.md) / api/endpoints/types + +# api/endpoints/types + +## Contents + +- [References](types.md#references) + - [DecodeVinExtendedResults](types.md#decodevinextendedresults) + - [DecodeVinExtendedVariable](types.md#decodevinextendedvariable) + - [DecodeVinResults](types.md#decodevinresults) + - [DecodeVinValuesBatchResults](types.md#decodevinvaluesbatchresults) + - [DecodeVinValuesExtendedResults](types.md#decodevinvaluesextendedresults) + - [DecodeVinValuesResults](types.md#decodevinvaluesresults) + - [DecodeVinVariable](types.md#decodevinvariable) + - [DecodeWMIResults](types.md#decodewmiresults) + - [GetAllMakesResults](types.md#getallmakesresults) + - [GetAllManufacturersResults](types.md#getallmanufacturersresults) + - [GetCanadianVehicleSpecificationsResults](types.md#getcanadianvehiclespecificationsresults) + - [GetEquipmentPlantCodesParams](types.md#getequipmentplantcodesparams) + - [GetEquipmentPlantCodesResults](types.md#getequipmentplantcodesresults) + - [GetMakeForManufacturerResults](types.md#getmakeformanufacturerresults) + - [GetMakesForManufacturerAndYearResults](types.md#getmakesformanufacturerandyearresults) + - [GetMakesForVehicleTypeResults](types.md#getmakesforvehicletyperesults) + - [GetManufacturerDetailsResults](types.md#getmanufacturerdetailsresults) + - [GetModelsForMakeIdResults](types.md#getmodelsformakeidresults) + - [GetModelsForMakeIdYearResults](types.md#getmodelsformakeidyearresults) + - [GetModelsForMakeResults](types.md#getmodelsformakeresults) + - [GetModelsForMakeYearResults](types.md#getmodelsformakeyearresults) + - [GetPartsResults](types.md#getpartsresults) + - [GetVehicleTypesForMakeIdResults](types.md#getvehicletypesformakeidresults) + - [GetVehicleTypesForMakeResults](types.md#getvehicletypesformakeresults) + - [GetVehicleVariableListResults](types.md#getvehiclevariablelistresults) + - [GetVehicleVariableValuesListResults](types.md#getvehiclevariablevalueslistresults) + - [GetWMIsForManufacturerResults](types.md#getwmisformanufacturerresults) + +## References + +### DecodeVinExtendedResults + +Re-exports [DecodeVinExtendedResults](DecodeVinExtended.md#decodevinextendedresults) + +### DecodeVinExtendedVariable + +Re-exports [DecodeVinExtendedVariable](DecodeVinExtended.md#decodevinextendedvariable) + +### DecodeVinResults + +Re-exports [DecodeVinResults](DecodeVin.md#decodevinresults) + +### DecodeVinValuesBatchResults + +Re-exports [DecodeVinValuesBatchResults](DecodeVinValuesBatch.md#decodevinvaluesbatchresults) + +### DecodeVinValuesExtendedResults + +Re-exports [DecodeVinValuesExtendedResults](DecodeVinValuesExtended.md#decodevinvaluesextendedresults) + +### DecodeVinValuesResults + +Re-exports [DecodeVinValuesResults](DecodeVinValues.md#decodevinvaluesresults) + +### DecodeVinVariable + +Re-exports [DecodeVinVariable](DecodeVin.md#decodevinvariable) + +### DecodeWMIResults + +Re-exports [DecodeWMIResults](DecodeWMI.md#decodewmiresults) + +### GetAllMakesResults + +Re-exports [GetAllMakesResults](GetAllMakes.md#getallmakesresults) + +### GetAllManufacturersResults + +Re-exports [GetAllManufacturersResults](GetAllManufacturers.md#getallmanufacturersresults) + +### GetCanadianVehicleSpecificationsResults + +Re-exports [GetCanadianVehicleSpecificationsResults](GetCanadianVehicleSpecifications.md#getcanadianvehiclespecificationsresults) + +### GetEquipmentPlantCodesParams + +Re-exports [GetEquipmentPlantCodesParams](GetEquipmentPlantCodes.md#getequipmentplantcodesparams) + +### GetEquipmentPlantCodesResults + +Re-exports [GetEquipmentPlantCodesResults](GetEquipmentPlantCodes.md#getequipmentplantcodesresults) + +### GetMakeForManufacturerResults + +Re-exports [GetMakeForManufacturerResults](GetMakeForManufacturer.md#getmakeformanufacturerresults) + +### GetMakesForManufacturerAndYearResults + +Re-exports [GetMakesForManufacturerAndYearResults](GetMakesForManufacturerAndYear.md#getmakesformanufacturerandyearresults) + +### GetMakesForVehicleTypeResults + +Re-exports [GetMakesForVehicleTypeResults](GetMakesForVehicleType.md#getmakesforvehicletyperesults) + +### GetManufacturerDetailsResults + +Re-exports [GetManufacturerDetailsResults](GetManufacturerDetails.md#getmanufacturerdetailsresults) + +### GetModelsForMakeIdResults + +Re-exports [GetModelsForMakeIdResults](GetModelsForMakeId.md#getmodelsformakeidresults) + +### GetModelsForMakeIdYearResults + +Re-exports [GetModelsForMakeIdYearResults](GetModelsForMakeIdYear.md#getmodelsformakeidyearresults) + +### GetModelsForMakeResults + +Re-exports [GetModelsForMakeResults](GetModelsForMake.md#getmodelsformakeresults) + +### GetModelsForMakeYearResults + +Re-exports [GetModelsForMakeYearResults](GetModelsForMakeYear.md#getmodelsformakeyearresults) + +### GetPartsResults + +Re-exports [GetPartsResults](GetParts.md#getpartsresults) + +### GetVehicleTypesForMakeIdResults + +Re-exports [GetVehicleTypesForMakeIdResults](GetVehicleTypesForMakeId.md#getvehicletypesformakeidresults) + +### GetVehicleTypesForMakeResults + +Re-exports [GetVehicleTypesForMakeResults](GetVehicleTypesForMake.md#getvehicletypesformakeresults) + +### GetVehicleVariableListResults + +Re-exports [GetVehicleVariableListResults](GetVehicleVariableList.md#getvehiclevariablelistresults) + +### GetVehicleVariableValuesListResults + +Re-exports [GetVehicleVariableValuesListResults](GetVehicleVariableValuesList.md#getvehiclevariablevalueslistresults) + +### GetWMIsForManufacturerResults + +Re-exports [GetWMIsForManufacturerResults](GetWMIsForManufacturer.md#getwmisformanufacturerresults) diff --git a/apps/docs/src/typedoc/api/types.md b/apps/docs/src/typedoc/api/types.md new file mode 100644 index 00000000..e981f99f --- /dev/null +++ b/apps/docs/src/typedoc/api/types.md @@ -0,0 +1,182 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../modules.md) / api/types + +# api/types + +## Contents + +- [References](types.md#references) + - [CreateUrlOptions](types.md#createurloptions) + - [DecodeVinExtendedResults](types.md#decodevinextendedresults) + - [DecodeVinExtendedVariable](types.md#decodevinextendedvariable) + - [DecodeVinResults](types.md#decodevinresults) + - [DecodeVinValuesBatchResults](types.md#decodevinvaluesbatchresults) + - [DecodeVinValuesExtendedResults](types.md#decodevinvaluesextendedresults) + - [DecodeVinValuesResults](types.md#decodevinvaluesresults) + - [DecodeVinVariable](types.md#decodevinvariable) + - [DecodeWMIResults](types.md#decodewmiresults) + - [GetAllMakesResults](types.md#getallmakesresults) + - [GetAllManufacturersResults](types.md#getallmanufacturersresults) + - [GetCanadianVehicleSpecificationsResults](types.md#getcanadianvehiclespecificationsresults) + - [GetEquipmentPlantCodesParams](types.md#getequipmentplantcodesparams) + - [GetEquipmentPlantCodesResults](types.md#getequipmentplantcodesresults) + - [GetMakeForManufacturerResults](types.md#getmakeformanufacturerresults) + - [GetMakesForManufacturerAndYearResults](types.md#getmakesformanufacturerandyearresults) + - [GetMakesForVehicleTypeResults](types.md#getmakesforvehicletyperesults) + - [GetManufacturerDetailsResults](types.md#getmanufacturerdetailsresults) + - [GetModelsForMakeIdResults](types.md#getmodelsformakeidresults) + - [GetModelsForMakeIdYearResults](types.md#getmodelsformakeidyearresults) + - [GetModelsForMakeResults](types.md#getmodelsformakeresults) + - [GetModelsForMakeYearResults](types.md#getmodelsformakeyearresults) + - [GetPartsResults](types.md#getpartsresults) + - [GetVehicleTypesForMakeIdResults](types.md#getvehicletypesformakeidresults) + - [GetVehicleTypesForMakeResults](types.md#getvehicletypesformakeresults) + - [GetVehicleVariableListResults](types.md#getvehiclevariablelistresults) + - [GetVehicleVariableValuesListResults](types.md#getvehiclevariablevalueslistresults) + - [GetWMIsForManufacturerResults](types.md#getwmisformanufacturerresults) +- [Type Aliases](types.md#type-aliases) + - [NhtsaResponse``](types.md#nhtsaresponset) + +## References + +### CreateUrlOptions + +Re-exports [CreateUrlOptions](useNHTSA.md#createurloptions) + +### DecodeVinExtendedResults + +Re-exports [DecodeVinExtendedResults](endpoints/DecodeVinExtended.md#decodevinextendedresults) + +### DecodeVinExtendedVariable + +Re-exports [DecodeVinExtendedVariable](endpoints/DecodeVinExtended.md#decodevinextendedvariable) + +### DecodeVinResults + +Re-exports [DecodeVinResults](endpoints/DecodeVin.md#decodevinresults) + +### DecodeVinValuesBatchResults + +Re-exports [DecodeVinValuesBatchResults](endpoints/DecodeVinValuesBatch.md#decodevinvaluesbatchresults) + +### DecodeVinValuesExtendedResults + +Re-exports [DecodeVinValuesExtendedResults](endpoints/DecodeVinValuesExtended.md#decodevinvaluesextendedresults) + +### DecodeVinValuesResults + +Re-exports [DecodeVinValuesResults](endpoints/DecodeVinValues.md#decodevinvaluesresults) + +### DecodeVinVariable + +Re-exports [DecodeVinVariable](endpoints/DecodeVin.md#decodevinvariable) + +### DecodeWMIResults + +Re-exports [DecodeWMIResults](endpoints/DecodeWMI.md#decodewmiresults) + +### GetAllMakesResults + +Re-exports [GetAllMakesResults](endpoints/GetAllMakes.md#getallmakesresults) + +### GetAllManufacturersResults + +Re-exports [GetAllManufacturersResults](endpoints/GetAllManufacturers.md#getallmanufacturersresults) + +### GetCanadianVehicleSpecificationsResults + +Re-exports [GetCanadianVehicleSpecificationsResults](endpoints/GetCanadianVehicleSpecifications.md#getcanadianvehiclespecificationsresults) + +### GetEquipmentPlantCodesParams + +Re-exports [GetEquipmentPlantCodesParams](endpoints/GetEquipmentPlantCodes.md#getequipmentplantcodesparams) + +### GetEquipmentPlantCodesResults + +Re-exports [GetEquipmentPlantCodesResults](endpoints/GetEquipmentPlantCodes.md#getequipmentplantcodesresults) + +### GetMakeForManufacturerResults + +Re-exports [GetMakeForManufacturerResults](endpoints/GetMakeForManufacturer.md#getmakeformanufacturerresults) + +### GetMakesForManufacturerAndYearResults + +Re-exports [GetMakesForManufacturerAndYearResults](endpoints/GetMakesForManufacturerAndYear.md#getmakesformanufacturerandyearresults) + +### GetMakesForVehicleTypeResults + +Re-exports [GetMakesForVehicleTypeResults](endpoints/GetMakesForVehicleType.md#getmakesforvehicletyperesults) + +### GetManufacturerDetailsResults + +Re-exports [GetManufacturerDetailsResults](endpoints/GetManufacturerDetails.md#getmanufacturerdetailsresults) + +### GetModelsForMakeIdResults + +Re-exports [GetModelsForMakeIdResults](endpoints/GetModelsForMakeId.md#getmodelsformakeidresults) + +### GetModelsForMakeIdYearResults + +Re-exports [GetModelsForMakeIdYearResults](endpoints/GetModelsForMakeIdYear.md#getmodelsformakeidyearresults) + +### GetModelsForMakeResults + +Re-exports [GetModelsForMakeResults](endpoints/GetModelsForMake.md#getmodelsformakeresults) + +### GetModelsForMakeYearResults + +Re-exports [GetModelsForMakeYearResults](endpoints/GetModelsForMakeYear.md#getmodelsformakeyearresults) + +### GetPartsResults + +Re-exports [GetPartsResults](endpoints/GetParts.md#getpartsresults) + +### GetVehicleTypesForMakeIdResults + +Re-exports [GetVehicleTypesForMakeIdResults](endpoints/GetVehicleTypesForMakeId.md#getvehicletypesformakeidresults) + +### GetVehicleTypesForMakeResults + +Re-exports [GetVehicleTypesForMakeResults](endpoints/GetVehicleTypesForMake.md#getvehicletypesformakeresults) + +### GetVehicleVariableListResults + +Re-exports [GetVehicleVariableListResults](endpoints/GetVehicleVariableList.md#getvehiclevariablelistresults) + +### GetVehicleVariableValuesListResults + +Re-exports [GetVehicleVariableValuesListResults](endpoints/GetVehicleVariableValuesList.md#getvehiclevariablevalueslistresults) + +### GetWMIsForManufacturerResults + +Re-exports [GetWMIsForManufacturerResults](endpoints/GetWMIsForManufacturer.md#getwmisformanufacturerresults) + +## Type Aliases + +### NhtsaResponse`` + +> **NhtsaResponse**\<`T`\>: `object` + +Response data returned from the NHTSA VPIC API. `Results` key will be an array of objects of type "T" + +#### Type parameters + +| Parameter | +| :------ | +| `T` | + +#### Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `Count` | `number` | The number of items returned in the Results object. Will = 0 if no Results | +| `Message` | `string` | A message describing the Results. If Count is 0 check the Message for helpful info | +| `Results` | `T`[] | An array of objects returned by NHTSA VPIC API, specific to each individual API Action. | +| `SearchCriteria` | `string` \| `null` | Search terms (VIN, WMI, etc) used in the request URL. | + +#### Source + +[api/types.ts:12](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/types.ts#L12) diff --git a/apps/docs/src/typedoc/api/useNHTSA.md b/apps/docs/src/typedoc/api/useNHTSA.md new file mode 100644 index 00000000..e2d96b35 --- /dev/null +++ b/apps/docs/src/typedoc/api/useNHTSA.md @@ -0,0 +1,85 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../modules.md) / api/useNHTSA + +# api/useNHTSA + +## Contents + +- [Type Aliases](useNHTSA.md#type-aliases) + - [CreateUrlOptions](useNHTSA.md#createurloptions) +- [Functions](useNHTSA.md#functions) + - [useNHTSA()](useNHTSA.md#usenhtsa) + +## Type Aliases + +### CreateUrlOptions + +> **CreateUrlOptions**: `object` + +#### Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `allowEmptyParams` | `boolean` | - | +| `endpointName` | `string` | - | +| `includeQueryString` | `boolean` | - | +| `params` | [`QueryStringParams`](../utils/queryString.md#querystringparams) | - | +| `path` | `string` | - | +| `saveUrl` | `boolean` | - | + +#### Source + +[api/useNHTSA.ts:15](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/useNHTSA.ts#L15) + +## Functions + +### useNHTSA() + +> **useNHTSA**(): `object` + +`useNHTSA` returns a composable object containing helper functions for working with the VPIC +API. It is used internally by the package and by users to make direct requests to the VPIC API. + +It returns an object containing methods for making HTTP requests to the VPIC API. All +request methods return a Promise that resolves to an object containing the full response data. + +The functions returned by the composable are: + +- `createCachedUrl` - Builds the URL string and stores it in internal state + +- `getCachedUrl` - Gets the URL stored in internal state + +- `setCachedUrl` - Directly sets the URL internal state, does not check if URL is valid + +- `clearCachedUrl` - Clears the URL stored in internal state + +- `createUrl` - Returns a built URL string but does not store it in internal state + +- `createPostBody` - Creates a POST body string from an object of key/value pairs + +- `get` - Makes a GET request, uses the internal url variable if no URL is provided + +- `post` - Makes a POST request, uses the internal url variable if no URL is provided + +#### Returns + +`object` + +> | Member | Type | Description | +> | :------ | :------ | :------ | +> | `clearCachedUrl` | () => `string` | - | +> | `createCachedUrl` | (`input`) => `string` | - | +> | `createPostBody` | (`data`) => `string` | - | +> | `createUrl` | (`options`) => `string` | - | +> | `get` | \<`T`\>(`url`?, `options`?) => `Promise`\<[`NhtsaResponse`](types.md#nhtsaresponset)\<`T`\>\> | - | +> | `getCachedUrl` | () => `string` | - | +> | `post` | \<`T`\>(`url`?, `options`?) => `Promise`\<[`NhtsaResponse`](types.md#nhtsaresponset)\<`T`\>\> | - | +> | `setCachedUrl` | (`url`) => `string` | - | +> + +#### Source + +[api/useNHTSA.ts:50](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/useNHTSA.ts#L50) diff --git a/apps/docs/src/typedoc/constants.md b/apps/docs/src/typedoc/constants.md new file mode 100644 index 00000000..80540363 --- /dev/null +++ b/apps/docs/src/typedoc/constants.md @@ -0,0 +1,33 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](modules.md) / constants + +# constants + +## Contents + +- [Variables](constants.md#variables) + - [NHTSA\_BASE\_URL](constants.md#nhtsa-base-url) + - [NHTSA\_RESPONSE\_FORMAT](constants.md#nhtsa-response-format) + +## Variables + +### NHTSA\_BASE\_URL + +> **`const`** **NHTSA\_BASE\_URL**: `"https://vpic.nhtsa.dot.gov/api/vehicles"` = `'https://vpic.nhtsa.dot.gov/api/vehicles'` + +#### Source + +[constants.ts:1](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/constants.ts#L1) + +*** + +### NHTSA\_RESPONSE\_FORMAT + +> **`const`** **NHTSA\_RESPONSE\_FORMAT**: `"json"` = `'json'` + +#### Source + +[constants.ts:2](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/constants.ts#L2) diff --git a/apps/docs/src/typedoc/global.md b/apps/docs/src/typedoc/global.md new file mode 100644 index 00000000..31360811 --- /dev/null +++ b/apps/docs/src/typedoc/global.md @@ -0,0 +1,7 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](modules.md) / global + +# global diff --git a/apps/docs/src/typedoc/index.md b/apps/docs/src/typedoc/index.md index f76a1147..98ea92fd 100644 --- a/apps/docs/src/typedoc/index.md +++ b/apps/docs/src/typedoc/index.md @@ -1,4 +1,6 @@ -@shaggytools/nhtsa-api-wrapper / [Exports](modules.md) +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( Readme \| [API](modules.md) ) + +*** ::: tip :bulb: Auto-generated By TypeDoc from package source code ::: diff --git a/apps/docs/src/typedoc/module.index.md b/apps/docs/src/typedoc/module.index.md new file mode 100644 index 00000000..c2045277 --- /dev/null +++ b/apps/docs/src/typedoc/module.index.md @@ -0,0 +1,328 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](modules.md) / index + +# index + +## Contents + +- [References](module.index.md#references) + - [AtLeastOne](module.index.md#atleastone) + - [CreateUrlOptions](module.index.md#createurloptions) + - [DecodeVin](module.index.md#decodevin) + - [DecodeVinExtended](module.index.md#decodevinextended) + - [DecodeVinExtendedResults](module.index.md#decodevinextendedresults) + - [DecodeVinExtendedVariable](module.index.md#decodevinextendedvariable) + - [DecodeVinResults](module.index.md#decodevinresults) + - [DecodeVinValues](module.index.md#decodevinvalues) + - [DecodeVinValuesBatch](module.index.md#decodevinvaluesbatch) + - [DecodeVinValuesBatchResults](module.index.md#decodevinvaluesbatchresults) + - [DecodeVinValuesExtended](module.index.md#decodevinvaluesextended) + - [DecodeVinValuesExtendedResults](module.index.md#decodevinvaluesextendedresults) + - [DecodeVinValuesResults](module.index.md#decodevinvaluesresults) + - [DecodeVinVariable](module.index.md#decodevinvariable) + - [DecodeWMI](module.index.md#decodewmi) + - [DecodeWMIResults](module.index.md#decodewmiresults) + - [GetAllMakes](module.index.md#getallmakes) + - [GetAllMakesResults](module.index.md#getallmakesresults) + - [GetAllManufacturers](module.index.md#getallmanufacturers) + - [GetAllManufacturersResults](module.index.md#getallmanufacturersresults) + - [GetCanadianVehicleSpecifications](module.index.md#getcanadianvehiclespecifications) + - [GetCanadianVehicleSpecificationsResults](module.index.md#getcanadianvehiclespecificationsresults) + - [GetEquipmentPlantCodes](module.index.md#getequipmentplantcodes) + - [GetEquipmentPlantCodesParams](module.index.md#getequipmentplantcodesparams) + - [GetEquipmentPlantCodesResults](module.index.md#getequipmentplantcodesresults) + - [GetMakeForManufacturer](module.index.md#getmakeformanufacturer) + - [GetMakeForManufacturerResults](module.index.md#getmakeformanufacturerresults) + - [GetMakesForManufacturerAndYear](module.index.md#getmakesformanufacturerandyear) + - [GetMakesForManufacturerAndYearResults](module.index.md#getmakesformanufacturerandyearresults) + - [GetMakesForVehicleType](module.index.md#getmakesforvehicletype) + - [GetMakesForVehicleTypeResults](module.index.md#getmakesforvehicletyperesults) + - [GetManufacturerDetails](module.index.md#getmanufacturerdetails) + - [GetManufacturerDetailsResults](module.index.md#getmanufacturerdetailsresults) + - [GetModelsForMake](module.index.md#getmodelsformake) + - [GetModelsForMakeId](module.index.md#getmodelsformakeid) + - [GetModelsForMakeIdResults](module.index.md#getmodelsformakeidresults) + - [GetModelsForMakeIdYear](module.index.md#getmodelsformakeidyear) + - [GetModelsForMakeIdYearResults](module.index.md#getmodelsformakeidyearresults) + - [GetModelsForMakeResults](module.index.md#getmodelsformakeresults) + - [GetModelsForMakeYear](module.index.md#getmodelsformakeyear) + - [GetModelsForMakeYearResults](module.index.md#getmodelsformakeyearresults) + - [GetParts](module.index.md#getparts) + - [GetPartsResults](module.index.md#getpartsresults) + - [GetVehicleTypesForMake](module.index.md#getvehicletypesformake) + - [GetVehicleTypesForMakeId](module.index.md#getvehicletypesformakeid) + - [GetVehicleTypesForMakeIdResults](module.index.md#getvehicletypesformakeidresults) + - [GetVehicleTypesForMakeResults](module.index.md#getvehicletypesformakeresults) + - [GetVehicleVariableList](module.index.md#getvehiclevariablelist) + - [GetVehicleVariableListResults](module.index.md#getvehiclevariablelistresults) + - [GetVehicleVariableValuesList](module.index.md#getvehiclevariablevalueslist) + - [GetVehicleVariableValuesListResults](module.index.md#getvehiclevariablevalueslistresults) + - [GetWMIsForManufacturer](module.index.md#getwmisformanufacturer) + - [GetWMIsForManufacturerResults](module.index.md#getwmisformanufacturerresults) + - [IArgToValidate](module.index.md#iargtovalidate) + - [NhtsaResponse](module.index.md#nhtsaresponse) + - [QueryStringParams](module.index.md#querystringparams) + - [QueryStringParamsEncoded](module.index.md#querystringparamsencoded) + - [QueryStringTypes](module.index.md#querystringtypes) + - [RequireOnlyOne](module.index.md#requireonlyone) + - [createQueryString](module.index.md#createquerystring) + - [encodeQueryStringParams](module.index.md#encodequerystringparams) + - [isValidVin](module.index.md#isvalidvin) + - [useNHTSA](module.index.md#usenhtsa) + +## References + +### AtLeastOne + +Re-exports [AtLeastOne](utils/types.md#atleastonet-r) + +### CreateUrlOptions + +Re-exports [CreateUrlOptions](api/useNHTSA.md#createurloptions) + +### DecodeVin + +Re-exports [DecodeVin](api/endpoints/DecodeVin.md#decodevin) + +### DecodeVinExtended + +Re-exports [DecodeVinExtended](api/endpoints/DecodeVinExtended.md#decodevinextended) + +### DecodeVinExtendedResults + +Re-exports [DecodeVinExtendedResults](api/endpoints/DecodeVinExtended.md#decodevinextendedresults) + +### DecodeVinExtendedVariable + +Re-exports [DecodeVinExtendedVariable](api/endpoints/DecodeVinExtended.md#decodevinextendedvariable) + +### DecodeVinResults + +Re-exports [DecodeVinResults](api/endpoints/DecodeVin.md#decodevinresults) + +### DecodeVinValues + +Re-exports [DecodeVinValues](api/endpoints/DecodeVinValues.md#decodevinvalues) + +### DecodeVinValuesBatch + +Re-exports [DecodeVinValuesBatch](api/endpoints/DecodeVinValuesBatch.md#decodevinvaluesbatch) + +### DecodeVinValuesBatchResults + +Re-exports [DecodeVinValuesBatchResults](api/endpoints/DecodeVinValuesBatch.md#decodevinvaluesbatchresults) + +### DecodeVinValuesExtended + +Re-exports [DecodeVinValuesExtended](api/endpoints/DecodeVinValuesExtended.md#decodevinvaluesextended) + +### DecodeVinValuesExtendedResults + +Re-exports [DecodeVinValuesExtendedResults](api/endpoints/DecodeVinValuesExtended.md#decodevinvaluesextendedresults) + +### DecodeVinValuesResults + +Re-exports [DecodeVinValuesResults](api/endpoints/DecodeVinValues.md#decodevinvaluesresults) + +### DecodeVinVariable + +Re-exports [DecodeVinVariable](api/endpoints/DecodeVin.md#decodevinvariable) + +### DecodeWMI + +Re-exports [DecodeWMI](api/endpoints/DecodeWMI.md#decodewmi) + +### DecodeWMIResults + +Re-exports [DecodeWMIResults](api/endpoints/DecodeWMI.md#decodewmiresults) + +### GetAllMakes + +Re-exports [GetAllMakes](api/endpoints/GetAllMakes.md#getallmakes) + +### GetAllMakesResults + +Re-exports [GetAllMakesResults](api/endpoints/GetAllMakes.md#getallmakesresults) + +### GetAllManufacturers + +Re-exports [GetAllManufacturers](api/endpoints/GetAllManufacturers.md#getallmanufacturers) + +### GetAllManufacturersResults + +Re-exports [GetAllManufacturersResults](api/endpoints/GetAllManufacturers.md#getallmanufacturersresults) + +### GetCanadianVehicleSpecifications + +Re-exports [GetCanadianVehicleSpecifications](api/endpoints/GetCanadianVehicleSpecifications.md#getcanadianvehiclespecifications) + +### GetCanadianVehicleSpecificationsResults + +Re-exports [GetCanadianVehicleSpecificationsResults](api/endpoints/GetCanadianVehicleSpecifications.md#getcanadianvehiclespecificationsresults) + +### GetEquipmentPlantCodes + +Re-exports [GetEquipmentPlantCodes](api/endpoints/GetEquipmentPlantCodes.md#getequipmentplantcodes) + +### GetEquipmentPlantCodesParams + +Re-exports [GetEquipmentPlantCodesParams](api/endpoints/GetEquipmentPlantCodes.md#getequipmentplantcodesparams) + +### GetEquipmentPlantCodesResults + +Re-exports [GetEquipmentPlantCodesResults](api/endpoints/GetEquipmentPlantCodes.md#getequipmentplantcodesresults) + +### GetMakeForManufacturer + +Re-exports [GetMakeForManufacturer](api/endpoints/GetMakeForManufacturer.md#getmakeformanufacturer) + +### GetMakeForManufacturerResults + +Re-exports [GetMakeForManufacturerResults](api/endpoints/GetMakeForManufacturer.md#getmakeformanufacturerresults) + +### GetMakesForManufacturerAndYear + +Re-exports [GetMakesForManufacturerAndYear](api/endpoints/GetMakesForManufacturerAndYear.md#getmakesformanufacturerandyear) + +### GetMakesForManufacturerAndYearResults + +Re-exports [GetMakesForManufacturerAndYearResults](api/endpoints/GetMakesForManufacturerAndYear.md#getmakesformanufacturerandyearresults) + +### GetMakesForVehicleType + +Re-exports [GetMakesForVehicleType](api/endpoints/GetMakesForVehicleType.md#getmakesforvehicletype) + +### GetMakesForVehicleTypeResults + +Re-exports [GetMakesForVehicleTypeResults](api/endpoints/GetMakesForVehicleType.md#getmakesforvehicletyperesults) + +### GetManufacturerDetails + +Re-exports [GetManufacturerDetails](api/endpoints/GetManufacturerDetails.md#getmanufacturerdetails) + +### GetManufacturerDetailsResults + +Re-exports [GetManufacturerDetailsResults](api/endpoints/GetManufacturerDetails.md#getmanufacturerdetailsresults) + +### GetModelsForMake + +Re-exports [GetModelsForMake](api/endpoints/GetModelsForMake.md#getmodelsformake) + +### GetModelsForMakeId + +Re-exports [GetModelsForMakeId](api/endpoints/GetModelsForMakeId.md#getmodelsformakeid) + +### GetModelsForMakeIdResults + +Re-exports [GetModelsForMakeIdResults](api/endpoints/GetModelsForMakeId.md#getmodelsformakeidresults) + +### GetModelsForMakeIdYear + +Re-exports [GetModelsForMakeIdYear](api/endpoints/GetModelsForMakeIdYear.md#getmodelsformakeidyear) + +### GetModelsForMakeIdYearResults + +Re-exports [GetModelsForMakeIdYearResults](api/endpoints/GetModelsForMakeIdYear.md#getmodelsformakeidyearresults) + +### GetModelsForMakeResults + +Re-exports [GetModelsForMakeResults](api/endpoints/GetModelsForMake.md#getmodelsformakeresults) + +### GetModelsForMakeYear + +Re-exports [GetModelsForMakeYear](api/endpoints/GetModelsForMakeYear.md#getmodelsformakeyear) + +### GetModelsForMakeYearResults + +Re-exports [GetModelsForMakeYearResults](api/endpoints/GetModelsForMakeYear.md#getmodelsformakeyearresults) + +### GetParts + +Re-exports [GetParts](api/endpoints/GetParts.md#getparts) + +### GetPartsResults + +Re-exports [GetPartsResults](api/endpoints/GetParts.md#getpartsresults) + +### GetVehicleTypesForMake + +Re-exports [GetVehicleTypesForMake](api/endpoints/GetVehicleTypesForMake.md#getvehicletypesformake) + +### GetVehicleTypesForMakeId + +Re-exports [GetVehicleTypesForMakeId](api/endpoints/GetVehicleTypesForMakeId.md#getvehicletypesformakeid) + +### GetVehicleTypesForMakeIdResults + +Re-exports [GetVehicleTypesForMakeIdResults](api/endpoints/GetVehicleTypesForMakeId.md#getvehicletypesformakeidresults) + +### GetVehicleTypesForMakeResults + +Re-exports [GetVehicleTypesForMakeResults](api/endpoints/GetVehicleTypesForMake.md#getvehicletypesformakeresults) + +### GetVehicleVariableList + +Re-exports [GetVehicleVariableList](api/endpoints/GetVehicleVariableList.md#getvehiclevariablelist) + +### GetVehicleVariableListResults + +Re-exports [GetVehicleVariableListResults](api/endpoints/GetVehicleVariableList.md#getvehiclevariablelistresults) + +### GetVehicleVariableValuesList + +Re-exports [GetVehicleVariableValuesList](api/endpoints/GetVehicleVariableValuesList.md#getvehiclevariablevalueslist) + +### GetVehicleVariableValuesListResults + +Re-exports [GetVehicleVariableValuesListResults](api/endpoints/GetVehicleVariableValuesList.md#getvehiclevariablevalueslistresults) + +### GetWMIsForManufacturer + +Re-exports [GetWMIsForManufacturer](api/endpoints/GetWMIsForManufacturer.md#getwmisformanufacturer) + +### GetWMIsForManufacturerResults + +Re-exports [GetWMIsForManufacturerResults](api/endpoints/GetWMIsForManufacturer.md#getwmisformanufacturerresults) + +### IArgToValidate + +Re-exports [IArgToValidate](utils/argHandler.md#iargtovalidate) + +### NhtsaResponse + +Re-exports [NhtsaResponse](api/types.md#nhtsaresponset) + +### QueryStringParams + +Re-exports [QueryStringParams](utils/queryString.md#querystringparams) + +### QueryStringParamsEncoded + +Re-exports [QueryStringParamsEncoded](utils/queryString.md#querystringparamsencodedt) + +### QueryStringTypes + +Re-exports [QueryStringTypes](utils/queryString.md#querystringtypes) + +### RequireOnlyOne + +Re-exports [RequireOnlyOne](utils/types.md#requireonlyonet-keys) + +### createQueryString + +Re-exports [createQueryString](utils/queryString.md#createquerystring) + +### encodeQueryStringParams + +Re-exports [encodeQueryStringParams](utils/queryString.md#encodequerystringparams) + +### isValidVin + +Re-exports [isValidVin](utils/isValidVin.md#isvalidvin) + +### useNHTSA + +Re-exports [useNHTSA](api/useNHTSA.md#usenhtsa) diff --git a/apps/docs/src/typedoc/modules.md b/apps/docs/src/typedoc/modules.md index 1eed68bd..f3d1615a 100644 --- a/apps/docs/src/typedoc/modules.md +++ b/apps/docs/src/typedoc/modules.md @@ -1,49 +1,71 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](index.md) / Exports +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](index.md) \| API ) + +*** # @shaggytools/nhtsa-api-wrapper - v3.0.4 -## Table of contents - -### Modules - -- [api](modules/api.md) -- [api/endpoints](modules/api_endpoints.md) -- [api/endpoints/DecodeVin](modules/api_endpoints_DecodeVin.md) -- [api/endpoints/DecodeVinExtended](modules/api_endpoints_DecodeVinExtended.md) -- [api/endpoints/DecodeVinValues](modules/api_endpoints_DecodeVinValues.md) -- [api/endpoints/DecodeVinValuesBatch](modules/api_endpoints_DecodeVinValuesBatch.md) -- [api/endpoints/DecodeVinValuesExtended](modules/api_endpoints_DecodeVinValuesExtended.md) -- [api/endpoints/DecodeWMI](modules/api_endpoints_DecodeWMI.md) -- [api/endpoints/GetAllMakes](modules/api_endpoints_GetAllMakes.md) -- [api/endpoints/GetAllManufacturers](modules/api_endpoints_GetAllManufacturers.md) -- [api/endpoints/GetCanadianVehicleSpecifications](modules/api_endpoints_GetCanadianVehicleSpecifications.md) -- [api/endpoints/GetEquipmentPlantCodes](modules/api_endpoints_GetEquipmentPlantCodes.md) -- [api/endpoints/GetMakeForManufacturer](modules/api_endpoints_GetMakeForManufacturer.md) -- [api/endpoints/GetMakesForManufacturerAndYear](modules/api_endpoints_GetMakesForManufacturerAndYear.md) -- [api/endpoints/GetMakesForVehicleType](modules/api_endpoints_GetMakesForVehicleType.md) -- [api/endpoints/GetManufacturerDetails](modules/api_endpoints_GetManufacturerDetails.md) -- [api/endpoints/GetModelsForMake](modules/api_endpoints_GetModelsForMake.md) -- [api/endpoints/GetModelsForMakeId](modules/api_endpoints_GetModelsForMakeId.md) -- [api/endpoints/GetModelsForMakeIdYear](modules/api_endpoints_GetModelsForMakeIdYear.md) -- [api/endpoints/GetModelsForMakeYear](modules/api_endpoints_GetModelsForMakeYear.md) -- [api/endpoints/GetParts](modules/api_endpoints_GetParts.md) -- [api/endpoints/GetVehicleTypesForMake](modules/api_endpoints_GetVehicleTypesForMake.md) -- [api/endpoints/GetVehicleTypesForMakeId](modules/api_endpoints_GetVehicleTypesForMakeId.md) -- [api/endpoints/GetVehicleVariableList](modules/api_endpoints_GetVehicleVariableList.md) -- [api/endpoints/GetVehicleVariableValuesList](modules/api_endpoints_GetVehicleVariableValuesList.md) -- [api/endpoints/GetWMIsForManufacturer](modules/api_endpoints_GetWMIsForManufacturer.md) -- [api/endpoints/types](modules/api_endpoints_types.md) -- [api/types](modules/api_types.md) -- [api/useNHTSA](modules/api_useNHTSA.md) -- [constants](modules/constants.md) -- [global](modules/global.md) -- [index](modules/index.md) -- [types](modules/types.md) -- [utils](modules/utils.md) -- [utils/argHandler](modules/utils_argHandler.md) -- [utils/errorHandler](modules/utils_errorHandler.md) -- [utils/getTypeof](modules/utils_getTypeof.md) -- [utils/isValidVin](modules/utils_isValidVin.md) -- [utils/queryString](modules/utils_queryString.md) -- [utils/types](modules/utils_types.md) -- [vite-env](modules/vite_env.md) +## API + +| Module | Description | +| :------ | :------ | +| [api](api.md) | - | +| [api/useNHTSA](api/useNHTSA.md) | - | + +## API Endpoints + +| Module | Description | +| :------ | :------ | +| [api/endpoints](api/endpoints.md) | - | +| [api/endpoints/DecodeVin](api/endpoints/DecodeVin.md) | - | +| [api/endpoints/DecodeVinExtended](api/endpoints/DecodeVinExtended.md) | - | +| [api/endpoints/DecodeVinValues](api/endpoints/DecodeVinValues.md) | - | +| [api/endpoints/DecodeVinValuesBatch](api/endpoints/DecodeVinValuesBatch.md) | - | +| [api/endpoints/DecodeVinValuesExtended](api/endpoints/DecodeVinValuesExtended.md) | - | +| [api/endpoints/DecodeWMI](api/endpoints/DecodeWMI.md) | - | +| [api/endpoints/GetAllMakes](api/endpoints/GetAllMakes.md) | - | +| [api/endpoints/GetAllManufacturers](api/endpoints/GetAllManufacturers.md) | - | +| [api/endpoints/GetCanadianVehicleSpecifications](api/endpoints/GetCanadianVehicleSpecifications.md) | - | +| [api/endpoints/GetEquipmentPlantCodes](api/endpoints/GetEquipmentPlantCodes.md) | - | +| [api/endpoints/GetMakeForManufacturer](api/endpoints/GetMakeForManufacturer.md) | - | +| [api/endpoints/GetMakesForManufacturerAndYear](api/endpoints/GetMakesForManufacturerAndYear.md) | - | +| [api/endpoints/GetMakesForVehicleType](api/endpoints/GetMakesForVehicleType.md) | - | +| [api/endpoints/GetManufacturerDetails](api/endpoints/GetManufacturerDetails.md) | - | +| [api/endpoints/GetModelsForMake](api/endpoints/GetModelsForMake.md) | - | +| [api/endpoints/GetModelsForMakeId](api/endpoints/GetModelsForMakeId.md) | - | +| [api/endpoints/GetModelsForMakeIdYear](api/endpoints/GetModelsForMakeIdYear.md) | - | +| [api/endpoints/GetModelsForMakeYear](api/endpoints/GetModelsForMakeYear.md) | - | +| [api/endpoints/GetParts](api/endpoints/GetParts.md) | - | +| [api/endpoints/GetVehicleTypesForMake](api/endpoints/GetVehicleTypesForMake.md) | - | +| [api/endpoints/GetVehicleTypesForMakeId](api/endpoints/GetVehicleTypesForMakeId.md) | - | +| [api/endpoints/GetVehicleVariableList](api/endpoints/GetVehicleVariableList.md) | - | +| [api/endpoints/GetVehicleVariableValuesList](api/endpoints/GetVehicleVariableValuesList.md) | - | +| [api/endpoints/GetWMIsForManufacturer](api/endpoints/GetWMIsForManufacturer.md) | - | + +## Other + +| Module | Description | +| :------ | :------ | +| [constants](constants.md) | - | +| [global](global.md) | - | +| [index](module.index.md) | - | +| [vite-env](vite-env.md) | - | + +## Types + +| Module | Description | +| :------ | :------ | +| [api/endpoints/types](api/endpoints/types.md) | - | +| [api/types](api/types.md) | - | +| [types](types.md) | - | +| [utils/types](utils/types.md) | - | + +## Utility Functions + +| Module | Description | +| :------ | :------ | +| [utils](utils.md) | - | +| [utils/argHandler](utils/argHandler.md) | - | +| [utils/errorHandler](utils/errorHandler.md) | - | +| [utils/getTypeof](utils/getTypeof.md) | - | +| [utils/isValidVin](utils/isValidVin.md) | - | +| [utils/queryString](utils/queryString.md) | - | diff --git a/apps/docs/src/typedoc/modules/api.md b/apps/docs/src/typedoc/modules/api.md deleted file mode 100644 index 1ab39513..00000000 --- a/apps/docs/src/typedoc/modules/api.md +++ /dev/null @@ -1,183 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api - -# Module: api - -## Table of contents - -### References - -- [DecodeVin](api.md#decodevin) -- [DecodeVinExtended](api.md#decodevinextended) -- [DecodeVinValues](api.md#decodevinvalues) -- [DecodeVinValuesBatch](api.md#decodevinvaluesbatch) -- [DecodeVinValuesExtended](api.md#decodevinvaluesextended) -- [DecodeWMI](api.md#decodewmi) -- [GetAllMakes](api.md#getallmakes) -- [GetAllManufacturers](api.md#getallmanufacturers) -- [GetCanadianVehicleSpecifications](api.md#getcanadianvehiclespecifications) -- [GetEquipmentPlantCodes](api.md#getequipmentplantcodes) -- [GetMakeForManufacturer](api.md#getmakeformanufacturer) -- [GetMakesForManufacturerAndYear](api.md#getmakesformanufacturerandyear) -- [GetMakesForVehicleType](api.md#getmakesforvehicletype) -- [GetManufacturerDetails](api.md#getmanufacturerdetails) -- [GetModelsForMake](api.md#getmodelsformake) -- [GetModelsForMakeId](api.md#getmodelsformakeid) -- [GetModelsForMakeIdYear](api.md#getmodelsformakeidyear) -- [GetModelsForMakeYear](api.md#getmodelsformakeyear) -- [GetParts](api.md#getparts) -- [GetVehicleTypesForMake](api.md#getvehicletypesformake) -- [GetVehicleTypesForMakeId](api.md#getvehicletypesformakeid) -- [GetVehicleVariableList](api.md#getvehiclevariablelist) -- [GetVehicleVariableValuesList](api.md#getvehiclevariablevalueslist) -- [GetWMIsForManufacturer](api.md#getwmisformanufacturer) -- [useNHTSA](api.md#usenhtsa) - -## References - -### DecodeVin - -Re-exports [DecodeVin](api_endpoints_DecodeVin.md#decodevin) - ---- - -### DecodeVinExtended - -Re-exports [DecodeVinExtended](api_endpoints_DecodeVinExtended.md#decodevinextended) - ---- - -### DecodeVinValues - -Re-exports [DecodeVinValues](api_endpoints_DecodeVinValues.md#decodevinvalues) - ---- - -### DecodeVinValuesBatch - -Re-exports [DecodeVinValuesBatch](api_endpoints_DecodeVinValuesBatch.md#decodevinvaluesbatch) - ---- - -### DecodeVinValuesExtended - -Re-exports [DecodeVinValuesExtended](api_endpoints_DecodeVinValuesExtended.md#decodevinvaluesextended) - ---- - -### DecodeWMI - -Re-exports [DecodeWMI](api_endpoints_DecodeWMI.md#decodewmi) - ---- - -### GetAllMakes - -Re-exports [GetAllMakes](api_endpoints_GetAllMakes.md#getallmakes) - ---- - -### GetAllManufacturers - -Re-exports [GetAllManufacturers](api_endpoints_GetAllManufacturers.md#getallmanufacturers) - ---- - -### GetCanadianVehicleSpecifications - -Re-exports [GetCanadianVehicleSpecifications](api_endpoints_GetCanadianVehicleSpecifications.md#getcanadianvehiclespecifications) - ---- - -### GetEquipmentPlantCodes - -Re-exports [GetEquipmentPlantCodes](api_endpoints_GetEquipmentPlantCodes.md#getequipmentplantcodes) - ---- - -### GetMakeForManufacturer - -Re-exports [GetMakeForManufacturer](api_endpoints_GetMakeForManufacturer.md#getmakeformanufacturer) - ---- - -### GetMakesForManufacturerAndYear - -Re-exports [GetMakesForManufacturerAndYear](api_endpoints_GetMakesForManufacturerAndYear.md#getmakesformanufacturerandyear) - ---- - -### GetMakesForVehicleType - -Re-exports [GetMakesForVehicleType](api_endpoints_GetMakesForVehicleType.md#getmakesforvehicletype) - ---- - -### GetManufacturerDetails - -Re-exports [GetManufacturerDetails](api_endpoints_GetManufacturerDetails.md#getmanufacturerdetails) - ---- - -### GetModelsForMake - -Re-exports [GetModelsForMake](api_endpoints_GetModelsForMake.md#getmodelsformake) - ---- - -### GetModelsForMakeId - -Re-exports [GetModelsForMakeId](api_endpoints_GetModelsForMakeId.md#getmodelsformakeid) - ---- - -### GetModelsForMakeIdYear - -Re-exports [GetModelsForMakeIdYear](api_endpoints_GetModelsForMakeIdYear.md#getmodelsformakeidyear) - ---- - -### GetModelsForMakeYear - -Re-exports [GetModelsForMakeYear](api_endpoints_GetModelsForMakeYear.md#getmodelsformakeyear) - ---- - -### GetParts - -Re-exports [GetParts](api_endpoints_GetParts.md#getparts) - ---- - -### GetVehicleTypesForMake - -Re-exports [GetVehicleTypesForMake](api_endpoints_GetVehicleTypesForMake.md#getvehicletypesformake) - ---- - -### GetVehicleTypesForMakeId - -Re-exports [GetVehicleTypesForMakeId](api_endpoints_GetVehicleTypesForMakeId.md#getvehicletypesformakeid) - ---- - -### GetVehicleVariableList - -Re-exports [GetVehicleVariableList](api_endpoints_GetVehicleVariableList.md#getvehiclevariablelist) - ---- - -### GetVehicleVariableValuesList - -Re-exports [GetVehicleVariableValuesList](api_endpoints_GetVehicleVariableValuesList.md#getvehiclevariablevalueslist) - ---- - -### GetWMIsForManufacturer - -Re-exports [GetWMIsForManufacturer](api_endpoints_GetWMIsForManufacturer.md#getwmisformanufacturer) - ---- - -### useNHTSA - -Re-exports [useNHTSA](api_useNHTSA.md#usenhtsa) diff --git a/apps/docs/src/typedoc/modules/api_endpoints.md b/apps/docs/src/typedoc/modules/api_endpoints.md deleted file mode 100644 index 8fbbfa93..00000000 --- a/apps/docs/src/typedoc/modules/api_endpoints.md +++ /dev/null @@ -1,176 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/endpoints - -# Module: api/endpoints - -## Table of contents - -### References - -- [DecodeVin](api_endpoints.md#decodevin) -- [DecodeVinExtended](api_endpoints.md#decodevinextended) -- [DecodeVinValues](api_endpoints.md#decodevinvalues) -- [DecodeVinValuesBatch](api_endpoints.md#decodevinvaluesbatch) -- [DecodeVinValuesExtended](api_endpoints.md#decodevinvaluesextended) -- [DecodeWMI](api_endpoints.md#decodewmi) -- [GetAllMakes](api_endpoints.md#getallmakes) -- [GetAllManufacturers](api_endpoints.md#getallmanufacturers) -- [GetCanadianVehicleSpecifications](api_endpoints.md#getcanadianvehiclespecifications) -- [GetEquipmentPlantCodes](api_endpoints.md#getequipmentplantcodes) -- [GetMakeForManufacturer](api_endpoints.md#getmakeformanufacturer) -- [GetMakesForManufacturerAndYear](api_endpoints.md#getmakesformanufacturerandyear) -- [GetMakesForVehicleType](api_endpoints.md#getmakesforvehicletype) -- [GetManufacturerDetails](api_endpoints.md#getmanufacturerdetails) -- [GetModelsForMake](api_endpoints.md#getmodelsformake) -- [GetModelsForMakeId](api_endpoints.md#getmodelsformakeid) -- [GetModelsForMakeIdYear](api_endpoints.md#getmodelsformakeidyear) -- [GetModelsForMakeYear](api_endpoints.md#getmodelsformakeyear) -- [GetParts](api_endpoints.md#getparts) -- [GetVehicleTypesForMake](api_endpoints.md#getvehicletypesformake) -- [GetVehicleTypesForMakeId](api_endpoints.md#getvehicletypesformakeid) -- [GetVehicleVariableList](api_endpoints.md#getvehiclevariablelist) -- [GetVehicleVariableValuesList](api_endpoints.md#getvehiclevariablevalueslist) -- [GetWMIsForManufacturer](api_endpoints.md#getwmisformanufacturer) - -## References - -### DecodeVin - -Re-exports [DecodeVin](api_endpoints_DecodeVin.md#decodevin) - ---- - -### DecodeVinExtended - -Re-exports [DecodeVinExtended](api_endpoints_DecodeVinExtended.md#decodevinextended) - ---- - -### DecodeVinValues - -Re-exports [DecodeVinValues](api_endpoints_DecodeVinValues.md#decodevinvalues) - ---- - -### DecodeVinValuesBatch - -Re-exports [DecodeVinValuesBatch](api_endpoints_DecodeVinValuesBatch.md#decodevinvaluesbatch) - ---- - -### DecodeVinValuesExtended - -Re-exports [DecodeVinValuesExtended](api_endpoints_DecodeVinValuesExtended.md#decodevinvaluesextended) - ---- - -### DecodeWMI - -Re-exports [DecodeWMI](api_endpoints_DecodeWMI.md#decodewmi) - ---- - -### GetAllMakes - -Re-exports [GetAllMakes](api_endpoints_GetAllMakes.md#getallmakes) - ---- - -### GetAllManufacturers - -Re-exports [GetAllManufacturers](api_endpoints_GetAllManufacturers.md#getallmanufacturers) - ---- - -### GetCanadianVehicleSpecifications - -Re-exports [GetCanadianVehicleSpecifications](api_endpoints_GetCanadianVehicleSpecifications.md#getcanadianvehiclespecifications) - ---- - -### GetEquipmentPlantCodes - -Re-exports [GetEquipmentPlantCodes](api_endpoints_GetEquipmentPlantCodes.md#getequipmentplantcodes) - ---- - -### GetMakeForManufacturer - -Re-exports [GetMakeForManufacturer](api_endpoints_GetMakeForManufacturer.md#getmakeformanufacturer) - ---- - -### GetMakesForManufacturerAndYear - -Re-exports [GetMakesForManufacturerAndYear](api_endpoints_GetMakesForManufacturerAndYear.md#getmakesformanufacturerandyear) - ---- - -### GetMakesForVehicleType - -Re-exports [GetMakesForVehicleType](api_endpoints_GetMakesForVehicleType.md#getmakesforvehicletype) - ---- - -### GetManufacturerDetails - -Re-exports [GetManufacturerDetails](api_endpoints_GetManufacturerDetails.md#getmanufacturerdetails) - ---- - -### GetModelsForMake - -Re-exports [GetModelsForMake](api_endpoints_GetModelsForMake.md#getmodelsformake) - ---- - -### GetModelsForMakeId - -Re-exports [GetModelsForMakeId](api_endpoints_GetModelsForMakeId.md#getmodelsformakeid) - ---- - -### GetModelsForMakeIdYear - -Re-exports [GetModelsForMakeIdYear](api_endpoints_GetModelsForMakeIdYear.md#getmodelsformakeidyear) - ---- - -### GetModelsForMakeYear - -Re-exports [GetModelsForMakeYear](api_endpoints_GetModelsForMakeYear.md#getmodelsformakeyear) - ---- - -### GetParts - -Re-exports [GetParts](api_endpoints_GetParts.md#getparts) - ---- - -### GetVehicleTypesForMake - -Re-exports [GetVehicleTypesForMake](api_endpoints_GetVehicleTypesForMake.md#getvehicletypesformake) - ---- - -### GetVehicleTypesForMakeId - -Re-exports [GetVehicleTypesForMakeId](api_endpoints_GetVehicleTypesForMakeId.md#getvehicletypesformakeid) - ---- - -### GetVehicleVariableList - -Re-exports [GetVehicleVariableList](api_endpoints_GetVehicleVariableList.md#getvehiclevariablelist) - ---- - -### GetVehicleVariableValuesList - -Re-exports [GetVehicleVariableValuesList](api_endpoints_GetVehicleVariableValuesList.md#getvehiclevariablevalueslist) - ---- - -### GetWMIsForManufacturer - -Re-exports [GetWMIsForManufacturer](api_endpoints_GetWMIsForManufacturer.md#getwmisformanufacturer) diff --git a/apps/docs/src/typedoc/modules/api_endpoints_DecodeVin.md b/apps/docs/src/typedoc/modules/api_endpoints_DecodeVin.md deleted file mode 100644 index 7fa516ee..00000000 --- a/apps/docs/src/typedoc/modules/api_endpoints_DecodeVin.md +++ /dev/null @@ -1,172 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/endpoints/DecodeVin - -# Module: api/endpoints/DecodeVin - -## Table of contents - -### Type Aliases - -- [DecodeVinResults](api_endpoints_DecodeVin.md#decodevinresults) -- [DecodeVinVariable](api_endpoints_DecodeVin.md#decodevinvariable) - -### Functions - -- [DecodeVin](api_endpoints_DecodeVin.md#decodevin) - -## Type Aliases - -### DecodeVinResults - -Ƭ **DecodeVinResults**: `Object` - -Objects in the `Results` array of `DecodeVin` endpoint response. - -#### Type declaration - -| Name | Type | -| :----------- | :------------------------------------------------------------------ | -| `Value` | `string` \| `null` | -| `ValueId` | `string` \| `null` | -| `Variable` | [`DecodeVinVariable`](api_endpoints_DecodeVin.md#decodevinvariable) | -| `VariableId` | `number` | - -#### Defined in - -[api/endpoints/DecodeVin.ts:110](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVin.ts#L110) - ---- - -### DecodeVinVariable - -Ƭ **DecodeVinVariable**: `"Suggested VIN"` \| `"Error Code"` \| `"Possible Values"` \| `"Additional Error Text"` \| `"Error Text"` \| `"Vehicle Descriptor"` \| `"Destination Market"` \| `"Make"` \| `"Manufacturer Name"` \| `"Model"` \| `"Model Year"` \| `"Plant City"` \| `"Series"` \| `"Trim"` \| `"Vehicle Type"` \| `"Plant Country"` \| `"Plant Company Name"` \| `"Plant State"` \| `"Trim2"` \| `"Series2"` \| `"Note"` \| `"Base Price ($)"` \| `"Non-Land Use"` \| `"Body Class"` \| `"Doors"` \| `"Windows"` \| `"Wheel Base Type"` \| `"Track Width (inches)"` \| `"Gross Vehicle Weight Rating From"` \| `"Bed Length (inches)"` \| `"Curb Weight (pounds)"` \| `"Wheel Base (inches) From"` \| `"Wheel Base (inches) To"` \| `"Gross Combination Weight Rating From"` \| `"Gross Combination Weight Rating To"` \| `"Gross Vehicle Weight Rating To"` \| `"Bed Type"` \| `"Cab Type"` \| `"Trailer Type Connection"` \| `"Trailer Body Type"` \| `"Trailer Length (feet)"` \| `"Other Trailer Info"` \| `"Number of Wheels"` \| `"Wheel Size Front (inches)"` \| `"Wheel Size Rear (inches)"` \| `"Entertainment System"` \| `"Steering Location"` \| `"Number of Seats"` \| `"Number of Seat Rows"` \| `"Transmission Style"` \| `"Transmission Speeds"` \| `"Drive Type"` \| `"Axles"` \| `"Axle Configuration"` \| `"Brake System Type"` \| `"Brake System Description"` \| `"Other Battery Info"` \| `"Battery Type"` \| `"Number of Battery Cells per Module"` \| `"Battery Current (Amps) From"` \| `"Battery Voltage (Volts) From"` \| `"Battery Energy (kWh) From"` \| `"EV Drive Unit"` \| `"Battery Current (Amps) To"` \| `"Battery Voltage (Volts) To"` \| `"Battery Energy (kWh) To"` \| `"Number of Battery Modules per Pack"` \| `"Number of Battery Packs per Vehicle"` \| `"Charger Level"` \| `"Charger Power (kW)"` \| `"Engine Number of Cylinders"` \| `"Displacement (CC)"` \| `"Displacement (CI)"` \| `"Displacement (L)"` \| `"Engine Stroke Cycles"` \| `"Engine Model"` \| `"Engine Power (kW)"` \| `"Fuel Type - Primary"` \| `"Valve Train Design"` \| `"Engine Configuration"` \| `"Fuel Type - Secondary"` \| `"Fuel Delivery / Fuel Injection Type"` \| `"Engine Brake (hp) From"` \| `"Cooling Type"` \| `"Engine Brake (hp) To"` \| `"Electrification Level"` \| `"Other Engine Info"` \| `"Turbo"` \| `"Top Speed (MPH)"` \| `"Engine Manufacturer"` \| `"Pretensioner"` \| `"Seat Belt Type"` \| `"Other Restraint System Info"` \| `"Curtain Air Bag Locations"` \| `"Seat Cushion Air Bag Locations"` \| `"Front Air Bag Locations"` \| `"Knee Air Bag Locations"` \| `"Side Air Bag Locations"` \| `"Anti-lock Braking System (ABS)"` \| `"Electronic Stability Control (ESC)"` \| `"Traction Control"` \| `"Tire Pressure Monitoring System (TPMS) Type"` \| `"Active Safety System Note"` \| `"Auto-Reverse System for Windows and Sunroofs"` \| `"Automatic Pedestrian Alerting Sound (for Hybrid and EV only)"` \| `"Event Data Recorder (EDR)"` \| `"Keyless Ignition"` \| `"SAE Automation Level From"` \| `"SAE Automation Level To"` \| `"Adaptive Cruise Control (ACC)"` \| `"Crash Imminent Braking (CIB)"` \| `"Blind Spot Warning (BSW)"` \| `"Forward Collision Warning (FCW)"` \| `"Lane Departure Warning (LDW)"` \| `"Lane Keeping Assistance (LKA)"` \| `"Backup Camera"` \| `"Parking Assist"` \| `"Bus Length (feet)"` \| `"Bus Floor Configuration Type"` \| `"Bus Type"` \| `"Other Bus Info"` \| `"Custom Motorcycle Type"` \| `"Motorcycle Suspension Type"` \| `"Motorcycle Chassis Type"` \| `"Other Motorcycle Info"` \| `"Dynamic Brake Support (DBS)"` \| `"Pedestrian Automatic Emergency Braking (PAEB)"` \| `"Automatic Crash Notification (ACN) / Advanced Automatic Crash Notification (AACN)"` \| `"Daytime Running Light (DRL)"` \| `"Headlamp Light Source"` \| `"Semiautomatic Headlamp Beam Switching"` \| `"Adaptive Driving Beam (ADB)"` \| `"Rear Cross Traffic Alert"` \| `"Rear Automatic Emergency Braking"` \| `"Blind Spot Intervention (BSI)"` \| `"Lane Centering Assistance"` \| `string` & `Record`<`string`, `never`\> - -Possible `DecodeVinResults.Variable` values for DecodeVin endpoint. - -This type is here to provide a list of possible values manually extracted from an actual API -response. There are some things to note: - -- Names are ordered to mirror actual API response order. -- Names have been known to change slightly or be added/removed. -- Some listed here could be missing from the API response. -- There may be more actual values than listed here. - -Last Updated: 02/14/2023 - -#### Defined in - -[api/endpoints/DecodeVin.ts:129](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVin.ts#L129) - -## Functions - -### DecodeVin - -▸ **DecodeVin**(`vin`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeVinResults`](api_endpoints_DecodeVin.md#decodevinresults)\>\> - -::: tip :bulb: More Information -See: [DecodeVin Documentation](/api/endpoints/decode-vin) -::: - -`DecodeVin` decodes a Vehicle Identification Number (VIN) and returns useful information about -the vehicle. - -Providing `params.modelYear` allows for the decoding to specifically be done in the current, or -older (pre-1980), model year ranges. It is recommended to always provide `params.modelYear` if -the model year is known at the time of decoding, but it is not required. - -This endpoint also supports partial VIN decoding (VINs that are less than 17 characters). - -- Ex: 5UXWX7C5\*BA -- In this case, the VIN will be decoded partially with the available characters -- In case of partial VINs, a `*` could be used to indicate the unavailable characters -- The 9th digit is not necessary - -#### Parameters - -| Name | Type | Description | -| :---- | :------- | :---------------------------------------------- | -| `vin` | `string` | Vehicle Identification Number (full or partial) | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeVinResults`](api_endpoints_DecodeVin.md#decodevinresults)\>\> - -- Api Response `object` - -or- url `string` if `doFetch = false` - -#### Defined in - -[api/endpoints/DecodeVin.ts:36](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVin.ts#L36) - -▸ **DecodeVin**(`vin`, `doFetch`, `_dummy?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeVinResults`](api_endpoints_DecodeVin.md#decodevinresults)\>\> - -#### Parameters - -| Name | Type | -| :-------- | :---------- | -| `vin` | `string` | -| `doFetch` | `true` | -| `_dummy?` | `undefined` | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeVinResults`](api_endpoints_DecodeVin.md#decodevinresults)\>\> - -#### Defined in - -[api/endpoints/DecodeVin.ts:38](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVin.ts#L38) - -▸ **DecodeVin**(`vin`, `doFetch`, `_dummy?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :---------- | -| `vin` | `string` | -| `doFetch` | `false` | -| `_dummy?` | `undefined` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/DecodeVin.ts:44](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVin.ts#L44) - -▸ **DecodeVin**(`vin`, `params`, `doFetch`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------------ | :------------------- | -| `vin` | `string` | -| `params` | `Object` | -| `params.modelYear?` | `string` \| `number` | -| `doFetch` | `false` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/DecodeVin.ts:50](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVin.ts#L50) - -▸ **DecodeVin**(`vin`, `params?`, `doFetch?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeVinResults`](api_endpoints_DecodeVin.md#decodevinresults)\>\> - -#### Parameters - -| Name | Type | -| :------------------ | :------------------- | -| `vin` | `string` | -| `params?` | `Object` | -| `params.modelYear?` | `string` \| `number` | -| `doFetch?` | `true` | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeVinResults`](api_endpoints_DecodeVin.md#decodevinresults)\>\> - -#### Defined in - -[api/endpoints/DecodeVin.ts:56](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVin.ts#L56) diff --git a/apps/docs/src/typedoc/modules/api_endpoints_DecodeVinExtended.md b/apps/docs/src/typedoc/modules/api_endpoints_DecodeVinExtended.md deleted file mode 100644 index 54c97cd0..00000000 --- a/apps/docs/src/typedoc/modules/api_endpoints_DecodeVinExtended.md +++ /dev/null @@ -1,176 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/endpoints/DecodeVinExtended - -# Module: api/endpoints/DecodeVinExtended - -## Table of contents - -### Type Aliases - -- [DecodeVinExtendedResults](api_endpoints_DecodeVinExtended.md#decodevinextendedresults) -- [DecodeVinExtendedVariable](api_endpoints_DecodeVinExtended.md#decodevinextendedvariable) - -### Functions - -- [DecodeVinExtended](api_endpoints_DecodeVinExtended.md#decodevinextended) - -## Type Aliases - -### DecodeVinExtendedResults - -Ƭ **DecodeVinExtendedResults**: `Object` - -Objects in the `Results` array of `DecodeVinExtended` endpoint response. - -#### Type declaration - -| Name | Type | -| :----------- | :------------------------------------------------------------------------------------------ | -| `Value` | `string` \| `null` | -| `ValueId` | `string` \| `null` | -| `Variable` | [`DecodeVinExtendedVariable`](api_endpoints_DecodeVinExtended.md#decodevinextendedvariable) | -| `VariableId` | `number` | - -#### Defined in - -[api/endpoints/DecodeVinExtended.ts:116](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinExtended.ts#L116) - ---- - -### DecodeVinExtendedVariable - -Ƭ **DecodeVinExtendedVariable**: `"Suggested VIN"` \| `"Error Code"` \| `"Possible Values"` \| `"Additional Error Text"` \| `"Error Text"` \| `"Vehicle Descriptor"` \| `"Destination Market"` \| `"Make"` \| `"Manufacturer Name"` \| `"Model"` \| `"Model Year"` \| `"Plant City"` \| `"Series"` \| `"Trim"` \| `"Vehicle Type"` \| `"Plant Country"` \| `"Plant Company Name"` \| `"Plant State"` \| `"Trim2"` \| `"Series2"` \| `"Note"` \| `"Base Price ($)"` \| `"Non-Land Use"` \| `"Body Class"` \| `"Doors"` \| `"Windows"` \| `"Wheel Base Type"` \| `"Track Width (inches)"` \| `"Gross Vehicle Weight Rating From"` \| `"Bed Length (inches)"` \| `"Curb Weight (pounds)"` \| `"Wheel Base (inches) From"` \| `"Wheel Base (inches) To"` \| `"Gross Combination Weight Rating From"` \| `"Gross Combination Weight Rating To"` \| `"Gross Vehicle Weight Rating To"` \| `"Bed Type"` \| `"Cab Type"` \| `"Trailer Type Connection"` \| `"Trailer Body Type"` \| `"Trailer Length (feet)"` \| `"Other Trailer Info"` \| `"Number of Wheels"` \| `"Wheel Size Front (inches)"` \| `"Wheel Size Rear (inches)"` \| `"Entertainment System"` \| `"Steering Location"` \| `"Number of Seats"` \| `"Number of Seat Rows"` \| `"Transmission Style"` \| `"Transmission Speeds"` \| `"Drive Type"` \| `"Axles"` \| `"Axle Configuration"` \| `"Brake System Type"` \| `"Brake System Description"` \| `"Other Battery Info"` \| `"Battery Type"` \| `"Number of Battery Cells per Module"` \| `"Battery Current (Amps) From"` \| `"Battery Voltage (Volts) From"` \| `"Battery Energy (kWh) From"` \| `"EV Drive Unit"` \| `"Battery Current (Amps) To"` \| `"Battery Voltage (Volts) To"` \| `"Battery Energy (kWh) To"` \| `"Number of Battery Modules per Pack"` \| `"Number of Battery Packs per Vehicle"` \| `"Charger Level"` \| `"Charger Power (kW)"` \| `"Engine Number of Cylinders"` \| `"Displacement (CC)"` \| `"Displacement (CI)"` \| `"Displacement (L)"` \| `"Engine Stroke Cycles"` \| `"Engine Model"` \| `"Engine Power (kW)"` \| `"Fuel Type - Primary"` \| `"Valve Train Design"` \| `"Engine Configuration"` \| `"Fuel Type - Secondary"` \| `"Fuel Delivery / Fuel Injection Type"` \| `"Engine Brake (hp) From"` \| `"Cooling Type"` \| `"Engine Brake (hp) To"` \| `"Electrification Level"` \| `"Other Engine Info"` \| `"Turbo"` \| `"Top Speed (MPH)"` \| `"Engine Manufacturer"` \| `"Pretensioner"` \| `"Seat Belt Type"` \| `"Other Restraint System Info"` \| `"Curtain Air Bag Locations"` \| `"Seat Cushion Air Bag Locations"` \| `"Front Air Bag Locations"` \| `"Knee Air Bag Locations"` \| `"Side Air Bag Locations"` \| `"Anti-lock Braking System (ABS)"` \| `"Electronic Stability Control (ESC)"` \| `"Traction Control"` \| `"Tire Pressure Monitoring System (TPMS) Type"` \| `"Active Safety System Note"` \| `"Auto-Reverse System for Windows and Sunroofs"` \| `"Automatic Pedestrian Alerting Sound (for Hybrid and EV only)"` \| `"Event Data Recorder (EDR)"` \| `"Keyless Ignition"` \| `"SAE Automation Level From"` \| `"SAE Automation Level To"` \| `"NCSA Body Type"` \| `"NCSA Make"` \| `"NCSA Model"` \| `"NCSA Note"` \| `"Adaptive Cruise Control (ACC)"` \| `"Crash Imminent Braking (CIB)"` \| `"Blind Spot Warning (BSW)"` \| `"Forward Collision Warning (FCW)"` \| `"Lane Departure Warning (LDW)"` \| `"Lane Keeping Assistance (LKA)"` \| `"Backup Camera"` \| `"Parking Assist"` \| `"Bus Length (feet)"` \| `"Bus Floor Configuration Type"` \| `"Bus Type"` \| `"Other Bus Info"` \| `"Custom Motorcycle Type"` \| `"Motorcycle Suspension Type"` \| `"Motorcycle Chassis Type"` \| `"Other Motorcycle Info"` \| `"Dynamic Brake Support (DBS)"` \| `"Pedestrian Automatic Emergency Braking (PAEB)"` \| `"Automatic Crash Notification (ACN) / Advanced Automatic Crash Notification (AACN)"` \| `"Daytime Running Light (DRL)"` \| `"Headlamp Light Source"` \| `"Semiautomatic Headlamp Beam Switching"` \| `"Adaptive Driving Beam (ADB)"` \| `"Rear Cross Traffic Alert"` \| `"Rear Automatic Emergency Braking"` \| `"Blind Spot Intervention (BSI)"` \| `"Lane Centering Assistance"` \| `string` & `Record`<`string`, `never`\> - -Possible `DecodeVinExtendedResults.Variable` values for DecodeVinExtended endpoint. - -This type is here to provide a list of possible values manually extracted from an actual API -response. There are some things to note: - -- Names are ordered to mirror actual API response order. -- Names have been known to change slightly or be added/removed. -- Some listed here could be missing from the API response. -- There may be more actual values than listed here. - -Last Updated: 02/14/2023 - -#### Defined in - -[api/endpoints/DecodeVinExtended.ts:135](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinExtended.ts#L135) - -## Functions - -### DecodeVinExtended - -▸ **DecodeVinExtended**(`vin`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeVinExtendedResults`](api_endpoints_DecodeVinExtended.md#decodevinextendedresults)\>\> - -::: tip :bulb: More Information -See: [DecodeVinExtended Documentation](/api/endpoints/decode-vin-extended) -::: - -`DecodeVinExtended` decodes a Vehicle Identification Number (VIN) and returns useful information -about the vehicle. - -This endpoint is similar to `DecodeVin` but returns additional information on variables related -to other NHTSA programs like the -[NCSA](https://www.nhtsa.gov/research-data/national-center-statistics-and-analysis-ncsa). - -Providing `params.modelYear` allows for the decoding to specifically be done in the current, or -older (pre-1980), model year ranges. It is recommended to always provide `params.modelYear` if -the model year is known at the time of decoding, but it is not required. - -This endpoint also supports partial VIN decoding (VINs that are less than 17 characters). - -- Ex: 5UXWX7C5\*BA -- In this case, the VIN will be decoded partially with the available characters -- In case of partial VINs, a `*` could be used to indicate the unavailable characters -- The 9th digit is not necessary - -#### Parameters - -| Name | Type | Description | -| :---- | :------- | :---------------------------------------------- | -| `vin` | `string` | Vehicle Identification Number (full or partial) | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeVinExtendedResults`](api_endpoints_DecodeVinExtended.md#decodevinextendedresults)\>\> - -- Api Response `object` - -or- url `string` if `doFetch = false` (default: `true`) - -#### Defined in - -[api/endpoints/DecodeVinExtended.ts:40](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinExtended.ts#L40) - -▸ **DecodeVinExtended**(`vin`, `doFetch`, `_dummy?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeVinExtendedResults`](api_endpoints_DecodeVinExtended.md#decodevinextendedresults)\>\> - -#### Parameters - -| Name | Type | -| :-------- | :---------- | -| `vin` | `string` | -| `doFetch` | `true` | -| `_dummy?` | `undefined` | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeVinExtendedResults`](api_endpoints_DecodeVinExtended.md#decodevinextendedresults)\>\> - -#### Defined in - -[api/endpoints/DecodeVinExtended.ts:44](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinExtended.ts#L44) - -▸ **DecodeVinExtended**(`vin`, `doFetch`, `_dummy?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :---------- | -| `vin` | `string` | -| `doFetch` | `false` | -| `_dummy?` | `undefined` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/DecodeVinExtended.ts:50](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinExtended.ts#L50) - -▸ **DecodeVinExtended**(`vin`, `params`, `doFetch`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------------ | :------------------- | -| `vin` | `string` | -| `params` | `Object` | -| `params.modelYear?` | `string` \| `number` | -| `doFetch` | `false` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/DecodeVinExtended.ts:56](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinExtended.ts#L56) - -▸ **DecodeVinExtended**(`vin`, `params?`, `doFetch?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeVinExtendedResults`](api_endpoints_DecodeVinExtended.md#decodevinextendedresults)\>\> - -#### Parameters - -| Name | Type | -| :------------------ | :------------------- | -| `vin` | `string` | -| `params?` | `Object` | -| `params.modelYear?` | `string` \| `number` | -| `doFetch?` | `true` | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeVinExtendedResults`](api_endpoints_DecodeVinExtended.md#decodevinextendedresults)\>\> - -#### Defined in - -[api/endpoints/DecodeVinExtended.ts:62](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinExtended.ts#L62) diff --git a/apps/docs/src/typedoc/modules/api_endpoints_DecodeVinValues.md b/apps/docs/src/typedoc/modules/api_endpoints_DecodeVinValues.md deleted file mode 100644 index 42ea3c60..00000000 --- a/apps/docs/src/typedoc/modules/api_endpoints_DecodeVinValues.md +++ /dev/null @@ -1,315 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/endpoints/DecodeVinValues - -# Module: api/endpoints/DecodeVinValues - -## Table of contents - -### Type Aliases - -- [DecodeVinValuesParams](api_endpoints_DecodeVinValues.md#decodevinvaluesparams) -- [DecodeVinValuesResults](api_endpoints_DecodeVinValues.md#decodevinvaluesresults) - -### Functions - -- [DecodeVinValues](api_endpoints_DecodeVinValues.md#decodevinvalues) - -## Type Aliases - -### DecodeVinValuesParams - -Ƭ **DecodeVinValuesParams**: `Object` - -Query String Parameters for this endpoint - -#### Type declaration - -| Name | Type | -| :----------- | :------------------- | -| `modelYear?` | `string` \| `number` | - -#### Defined in - -[api/endpoints/DecodeVinValues.ts:111](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValues.ts#L111) - ---- - -### DecodeVinValuesResults - -Ƭ **DecodeVinValuesResults**: `Object` - -Single object found in the `Results` array of `DecodeVinValues` endpoint response. - -#### Type declaration - -| Name | Type | -| :------------------------------------ | :------- | -| `ABS` | `string` | -| `ActiveSafetySysNote` | `string` | -| `AdaptiveCruiseControl` | `string` | -| `AdaptiveDrivingBeam` | `string` | -| `AdaptiveHeadlights` | `string` | -| `AdditionalErrorText` | `string` | -| `AirBagLocCurtain` | `string` | -| `AirBagLocFront` | `string` | -| `AirBagLocKnee` | `string` | -| `AirBagLocSeatCushion` | `string` | -| `AirBagLocSide` | `string` | -| `AutoReverseSystem` | `string` | -| `AutomaticPedestrianAlertingSound` | `string` | -| `AxleConfiguration` | `string` | -| `Axles` | `string` | -| `BasePrice` | `string` | -| `BatteryA` | `string` | -| `BatteryA_to` | `string` | -| `BatteryCells` | `string` | -| `BatteryInfo` | `string` | -| `BatteryKWh` | `string` | -| `BatteryKWh_to` | `string` | -| `BatteryModules` | `string` | -| `BatteryPacks` | `string` | -| `BatteryType` | `string` | -| `BatteryV` | `string` | -| `BatteryV_to` | `string` | -| `BedLengthIN` | `string` | -| `BedType` | `string` | -| `BlindSpotIntervention` | `string` | -| `BlindSpotMon` | `string` | -| `BodyCabType` | `string` | -| `BodyClass` | `string` | -| `BrakeSystemDesc` | `string` | -| `BrakeSystemType` | `string` | -| `BusFloorConfigType` | `string` | -| `BusLength` | `string` | -| `BusType` | `string` | -| `CAN_AACN` | `string` | -| `CIB` | `string` | -| `CashForClunkers` | `string` | -| `ChargerLevel` | `string` | -| `ChargerPowerKW` | `string` | -| `CoolingType` | `string` | -| `CurbWeightLB` | `string` | -| `CustomMotorcycleType` | `string` | -| `DaytimeRunningLight` | `string` | -| `DestinationMarket` | `string` | -| `DisplacementCC` | `string` | -| `DisplacementCI` | `string` | -| `DisplacementL` | `string` | -| `Doors` | `string` | -| `DriveType` | `string` | -| `DriverAssist` | `string` | -| `DynamicBrakeSupport` | `string` | -| `EDR` | `string` | -| `ESC` | `string` | -| `EVDriveUnit` | `string` | -| `ElectrificationLevel` | `string` | -| `EngineConfiguration` | `string` | -| `EngineCycles` | `string` | -| `EngineCylinders` | `string` | -| `EngineHP` | `string` | -| `EngineHP_to` | `string` | -| `EngineKW` | `string` | -| `EngineManufacturer` | `string` | -| `EngineModel` | `string` | -| `EntertainmentSystem` | `string` | -| `ErrorCode` | `string` | -| `ErrorText` | `string` | -| `ForwardCollisionWarning` | `string` | -| `FuelInjectionType` | `string` | -| `FuelTypePrimary` | `string` | -| `FuelTypeSecondary` | `string` | -| `GCWR` | `string` | -| `GCWR_to` | `string` | -| `GVWR` | `string` | -| `GVWR_to` | `string` | -| `KeylessIgnition` | `string` | -| `LaneCenteringAssistance` | `string` | -| `LaneDepartureWarning` | `string` | -| `LaneKeepSystem` | `string` | -| `LowerBeamHeadlampLightSource` | `string` | -| `Make` | `string` | -| `MakeID` | `string` | -| `Manufacturer` | `string` | -| `ManufacturerId` | `string` | -| `Model` | `string` | -| `ModelID` | `string` | -| `ModelYear` | `string` | -| `MotorcycleChassisType` | `string` | -| `MotorcycleSuspensionType` | `string` | -| `NCSABodyType` | `string` | -| `NCSAMake` | `string` | -| `NCSAMapExcApprovedBy` | `string` | -| `NCSAMapExcApprovedOn` | `string` | -| `NCSAMappingException` | `string` | -| `NCSAModel` | `string` | -| `NCSANote` | `string` | -| `NonLandUse` | `string` | -| `Note` | `string` | -| `OtherBusInfo` | `string` | -| `OtherEngineInfo` | `string` | -| `OtherMotorcycleInfo` | `string` | -| `OtherRestraintSystemInfo` | `string` | -| `OtherTrailerInfo` | `string` | -| `ParkAssist` | `string` | -| `PedestrianAutomaticEmergencyBraking` | `string` | -| `PlantCity` | `string` | -| `PlantCompanyName` | `string` | -| `PlantCountry` | `string` | -| `PlantState` | `string` | -| `PossibleValues` | `string` | -| `Pretensioner` | `string` | -| `RearAutomaticEmergencyBraking` | `string` | -| `RearCrossTrafficAlert` | `string` | -| `RearVisibilitySystem` | `string` | -| `SAEAutomationLevel` | `string` | -| `SAEAutomationLevel_to` | `string` | -| `SeatBeltsAll` | `string` | -| `SeatRows` | `string` | -| `Seats` | `string` | -| `SemiautomaticHeadlampBeamSwitching` | `string` | -| `Series` | `string` | -| `Series2` | `string` | -| `SteeringLocation` | `string` | -| `SuggestedVIN` | `string` | -| `TPMS` | `string` | -| `TopSpeedMPH` | `string` | -| `TrackWidth` | `string` | -| `TractionControl` | `string` | -| `TrailerBodyType` | `string` | -| `TrailerLength` | `string` | -| `TrailerType` | `string` | -| `TransmissionSpeeds` | `string` | -| `TransmissionStyle` | `string` | -| `Trim` | `string` | -| `Trim2` | `string` | -| `Turbo` | `string` | -| `VIN` | `string` | -| `ValveTrainDesign` | `string` | -| `VehicleDescriptor` | `string` | -| `VehicleType` | `string` | -| `WheelBaseLong` | `string` | -| `WheelBaseShort` | `string` | -| `WheelBaseType` | `string` | -| `WheelSizeFront` | `string` | -| `WheelSizeRear` | `string` | -| `Wheels` | `string` | -| `Windows` | `string` | - -#### Defined in - -[api/endpoints/DecodeVinValues.ts:118](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValues.ts#L118) - -## Functions - -### DecodeVinValues - -▸ **DecodeVinValues**(`vin`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeVinValuesResults`](api_endpoints_DecodeVinValues.md#decodevinvaluesresults)\>\> - -::: tip :bulb: More Information -See: [DecodeVinValues Documentation](/api/endpoints/decode-vin-values) -::: - -`DecodeVinValues` decodes a Vehicle Identification Number (VIN) and returns useful information -about the vehicle in in a _flat format_. This means the endpoint will return an array with a -single object of results. Each key in the object is the name of a variable. - -Providing `params.modelYear` allows for the decoding to specifically be done in the current, or -older (pre-1980), model year ranges. It is recommended to always provide `params.modelYear` if -the model year is known at the time of decoding, but it is not required. - -This endpoint also supports partial VIN decoding (VINs that are less than 17 characters). - -- Ex: "5UXWX7C5\*BA" -- In this case, the VIN will be decoded partially with the available characters -- In case of partial VINs, a `*` could be used to indicate the unavailable characters -- The 9th digit is not necessary - -#### Parameters - -| Name | Type | Description | -| :---- | :------- | :---------------------------------------------- | -| `vin` | `string` | Vehicle Identification Number (full or partial) | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeVinValuesResults`](api_endpoints_DecodeVinValues.md#decodevinvaluesresults)\>\> - -- Api Response `object` - -or- url `string` if `doFetch = false` - -#### Defined in - -[api/endpoints/DecodeVinValues.ts:37](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValues.ts#L37) - -▸ **DecodeVinValues**(`vin`, `doFetch`, `_dummy?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeVinValuesResults`](api_endpoints_DecodeVinValues.md#decodevinvaluesresults)\>\> - -#### Parameters - -| Name | Type | -| :-------- | :---------- | -| `vin` | `string` | -| `doFetch` | `true` | -| `_dummy?` | `undefined` | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeVinValuesResults`](api_endpoints_DecodeVinValues.md#decodevinvaluesresults)\>\> - -#### Defined in - -[api/endpoints/DecodeVinValues.ts:41](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValues.ts#L41) - -▸ **DecodeVinValues**(`vin`, `doFetch`, `_dummy?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :---------- | -| `vin` | `string` | -| `doFetch` | `false` | -| `_dummy?` | `undefined` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/DecodeVinValues.ts:47](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValues.ts#L47) - -▸ **DecodeVinValues**(`vin`, `params`, `doFetch`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------------ | :------------------- | -| `vin` | `string` | -| `params` | `Object` | -| `params.modelYear?` | `string` \| `number` | -| `doFetch` | `false` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/DecodeVinValues.ts:53](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValues.ts#L53) - -▸ **DecodeVinValues**(`vin`, `params?`, `doFetch?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeVinValuesResults`](api_endpoints_DecodeVinValues.md#decodevinvaluesresults)\>\> - -#### Parameters - -| Name | Type | -| :------------------ | :------------------- | -| `vin` | `string` | -| `params?` | `Object` | -| `params.modelYear?` | `string` \| `number` | -| `doFetch?` | `true` | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeVinValuesResults`](api_endpoints_DecodeVinValues.md#decodevinvaluesresults)\>\> - -#### Defined in - -[api/endpoints/DecodeVinValues.ts:59](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValues.ts#L59) diff --git a/apps/docs/src/typedoc/modules/api_endpoints_DecodeVinValuesBatch.md b/apps/docs/src/typedoc/modules/api_endpoints_DecodeVinValuesBatch.md deleted file mode 100644 index 38ec1728..00000000 --- a/apps/docs/src/typedoc/modules/api_endpoints_DecodeVinValuesBatch.md +++ /dev/null @@ -1,247 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/endpoints/DecodeVinValuesBatch - -# Module: api/endpoints/DecodeVinValuesBatch - -## Table of contents - -### Type Aliases - -- [DecodeVinValuesBatchResults](api_endpoints_DecodeVinValuesBatch.md#decodevinvaluesbatchresults) - -### Functions - -- [DecodeVinValuesBatch](api_endpoints_DecodeVinValuesBatch.md#decodevinvaluesbatch) - -## Type Aliases - -### DecodeVinValuesBatchResults - -Ƭ **DecodeVinValuesBatchResults**: `Object` - -Objects found in the `Results` array of `DecodeVinValuesBatch` endpoint response. - -#### Type declaration - -| Name | Type | -| :------------------------------------ | :------- | -| `ABS` | `string` | -| `ActiveSafetySysNote` | `string` | -| `AdaptiveCruiseControl` | `string` | -| `AdaptiveDrivingBeam` | `string` | -| `AdaptiveHeadlights` | `string` | -| `AdditionalErrorText` | `string` | -| `AirBagLocCurtain` | `string` | -| `AirBagLocFront` | `string` | -| `AirBagLocKnee` | `string` | -| `AirBagLocSeatCushion` | `string` | -| `AirBagLocSide` | `string` | -| `AutoReverseSystem` | `string` | -| `AutomaticPedestrianAlertingSound` | `string` | -| `AxleConfiguration` | `string` | -| `Axles` | `string` | -| `BasePrice` | `string` | -| `BatteryA` | `string` | -| `BatteryA_to` | `string` | -| `BatteryCells` | `string` | -| `BatteryInfo` | `string` | -| `BatteryKWh` | `string` | -| `BatteryKWh_to` | `string` | -| `BatteryModules` | `string` | -| `BatteryPacks` | `string` | -| `BatteryType` | `string` | -| `BatteryV` | `string` | -| `BatteryV_to` | `string` | -| `BedLengthIN` | `string` | -| `BedType` | `string` | -| `BlindSpotIntervention` | `string` | -| `BlindSpotMon` | `string` | -| `BodyCabType` | `string` | -| `BodyClass` | `string` | -| `BrakeSystemDesc` | `string` | -| `BrakeSystemType` | `string` | -| `BusFloorConfigType` | `string` | -| `BusLength` | `string` | -| `BusType` | `string` | -| `CAN_AACN` | `string` | -| `CIB` | `string` | -| `CashForClunkers` | `string` | -| `ChargerLevel` | `string` | -| `ChargerPowerKW` | `string` | -| `CoolingType` | `string` | -| `CurbWeightLB` | `string` | -| `CustomMotorcycleType` | `string` | -| `DaytimeRunningLight` | `string` | -| `DestinationMarket` | `string` | -| `DisplacementCC` | `string` | -| `DisplacementCI` | `string` | -| `DisplacementL` | `string` | -| `Doors` | `string` | -| `DriveType` | `string` | -| `DriverAssist` | `string` | -| `DynamicBrakeSupport` | `string` | -| `EDR` | `string` | -| `ESC` | `string` | -| `EVDriveUnit` | `string` | -| `ElectrificationLevel` | `string` | -| `EngineConfiguration` | `string` | -| `EngineCycles` | `string` | -| `EngineCylinders` | `string` | -| `EngineHP` | `string` | -| `EngineHP_to` | `string` | -| `EngineKW` | `string` | -| `EngineManufacturer` | `string` | -| `EngineModel` | `string` | -| `EntertainmentSystem` | `string` | -| `ErrorCode` | `string` | -| `ErrorText` | `string` | -| `ForwardCollisionWarning` | `string` | -| `FuelInjectionType` | `string` | -| `FuelTypePrimary` | `string` | -| `FuelTypeSecondary` | `string` | -| `GCWR` | `string` | -| `GCWR_to` | `string` | -| `GVWR` | `string` | -| `GVWR_to` | `string` | -| `KeylessIgnition` | `string` | -| `LaneCenteringAssistance` | `string` | -| `LaneDepartureWarning` | `string` | -| `LaneKeepSystem` | `string` | -| `LowerBeamHeadlampLightSource` | `string` | -| `Make` | `string` | -| `MakeID` | `string` | -| `Manufacturer` | `string` | -| `ManufacturerId` | `string` | -| `Model` | `string` | -| `ModelID` | `string` | -| `ModelYear` | `string` | -| `MotorcycleChassisType` | `string` | -| `MotorcycleSuspensionType` | `string` | -| `NCSABodyType` | `string` | -| `NCSAMake` | `string` | -| `NCSAMapExcApprovedBy` | `string` | -| `NCSAMapExcApprovedOn` | `string` | -| `NCSAMappingException` | `string` | -| `NCSAModel` | `string` | -| `NCSANote` | `string` | -| `NonLandUse` | `string` | -| `Note` | `string` | -| `OtherBusInfo` | `string` | -| `OtherEngineInfo` | `string` | -| `OtherMotorcycleInfo` | `string` | -| `OtherRestraintSystemInfo` | `string` | -| `OtherTrailerInfo` | `string` | -| `ParkAssist` | `string` | -| `PedestrianAutomaticEmergencyBraking` | `string` | -| `PlantCity` | `string` | -| `PlantCompanyName` | `string` | -| `PlantCountry` | `string` | -| `PlantState` | `string` | -| `PossibleValues` | `string` | -| `Pretensioner` | `string` | -| `RearAutomaticEmergencyBraking` | `string` | -| `RearCrossTrafficAlert` | `string` | -| `RearVisibilitySystem` | `string` | -| `SAEAutomationLevel` | `string` | -| `SAEAutomationLevel_to` | `string` | -| `SeatBeltsAll` | `string` | -| `SeatRows` | `string` | -| `Seats` | `string` | -| `SemiautomaticHeadlampBeamSwitching` | `string` | -| `Series` | `string` | -| `Series2` | `string` | -| `SteeringLocation` | `string` | -| `SuggestedVIN` | `string` | -| `TPMS` | `string` | -| `TopSpeedMPH` | `string` | -| `TrackWidth` | `string` | -| `TractionControl` | `string` | -| `TrailerBodyType` | `string` | -| `TrailerLength` | `string` | -| `TrailerType` | `string` | -| `TransmissionSpeeds` | `string` | -| `TransmissionStyle` | `string` | -| `Trim` | `string` | -| `Trim2` | `string` | -| `Turbo` | `string` | -| `VIN` | `string` | -| `ValveTrainDesign` | `string` | -| `VehicleDescriptor` | `string` | -| `VehicleType` | `string` | -| `WheelBaseLong` | `string` | -| `WheelBaseShort` | `string` | -| `WheelBaseType` | `string` | -| `WheelSizeFront` | `string` | -| `WheelSizeRear` | `string` | -| `Wheels` | `string` | -| `Windows` | `string` | - -#### Defined in - -[api/endpoints/DecodeVinValuesBatch.ts:90](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValuesBatch.ts#L90) - -## Functions - -### DecodeVinValuesBatch - -▸ **DecodeVinValuesBatch**(`inputString`, `doFetch?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeVinValuesBatchResults`](api_endpoints_DecodeVinValuesBatch.md#decodevinvaluesbatchresults)\>\> - -::: tip :bulb: More Information -See: [DecodeVinValuesBatch Documentation](/api/endpoints/decode-vin-values-batch) -::: - -`DecodeVinValuesBatch` decodes a batch of Vehicle Identification Numbers (VINs) and returns -useful information about the vehicles in in a _flat format_. This means the endpoint will return -an array with multiple objects of results. Each object represents a VIN from the `inputString` -and the key:value pairs in the objects are variables and their values for each particular VIN. - -For this particular API you just have to provide a string of VINs, `inputString`, that are -separated by a `;`. You can also indicate the model year after the vin, preceded by a `,`. - -The `inputString` parameter should be in the following format: - -- ex: `5UXWX7C5*BA, 2011; 5YJSA3DS*EF` -- no modelYear: `vin; vin; vin` -- with modelYear: `vin, modelYear; vin, modelYear; vin, modelYear` -- mix of with/without modelYear: `vin; vin, modelYear` -- _vin_ and _modelYear_ are placeholders for real values in these examples -- all spaces between `;` and `,` are used in these examples for readability and are optional -- _Max 50 VINs per batch_ - -Providing the modelYear in the input string allows for the decoding to specifically be done in -the current, or older (pre-1980), model year ranges. It is recommended to always provide -the model year if it is known at the time of decoding, but it is not required. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :---------------------------------------------------------------------------------------------------------- | -| `inputString` | `string` | A string of Vehicle Identification Numbers (full or partial) following the format listed in the description | -| `doFetch?` | `true` | Whether to fetch the data or just return the URL (default: `true`) | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeVinValuesBatchResults`](api_endpoints_DecodeVinValuesBatch.md#decodevinvaluesbatchresults)\>\> - -- Api Response `object` - -or- url `string` if `doFetch = false` - -#### Defined in - -[api/endpoints/DecodeVinValuesBatch.ts:43](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValuesBatch.ts#L43) - -▸ **DecodeVinValuesBatch**(`inputString`, `doFetch`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `inputString` | `string` | -| `doFetch` | `false` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/DecodeVinValuesBatch.ts:48](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValuesBatch.ts#L48) diff --git a/apps/docs/src/typedoc/modules/api_endpoints_DecodeVinValuesExtended.md b/apps/docs/src/typedoc/modules/api_endpoints_DecodeVinValuesExtended.md deleted file mode 100644 index 0a15def2..00000000 --- a/apps/docs/src/typedoc/modules/api_endpoints_DecodeVinValuesExtended.md +++ /dev/null @@ -1,300 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/endpoints/DecodeVinValuesExtended - -# Module: api/endpoints/DecodeVinValuesExtended - -## Table of contents - -### Type Aliases - -- [DecodeVinValuesExtendedResults](api_endpoints_DecodeVinValuesExtended.md#decodevinvaluesextendedresults) - -### Functions - -- [DecodeVinValuesExtended](api_endpoints_DecodeVinValuesExtended.md#decodevinvaluesextended) - -## Type Aliases - -### DecodeVinValuesExtendedResults - -Ƭ **DecodeVinValuesExtendedResults**: `Object` - -Single object found in the `Results` array of `DecodeVinValuesExtended` endpoint response. - -#### Type declaration - -| Name | Type | -| :------------------------------------ | :------- | -| `ABS` | `string` | -| `ActiveSafetySysNote` | `string` | -| `AdaptiveCruiseControl` | `string` | -| `AdaptiveDrivingBeam` | `string` | -| `AdaptiveHeadlights` | `string` | -| `AdditionalErrorText` | `string` | -| `AirBagLocCurtain` | `string` | -| `AirBagLocFront` | `string` | -| `AirBagLocKnee` | `string` | -| `AirBagLocSeatCushion` | `string` | -| `AirBagLocSide` | `string` | -| `AutoReverseSystem` | `string` | -| `AutomaticPedestrianAlertingSound` | `string` | -| `AxleConfiguration` | `string` | -| `Axles` | `string` | -| `BasePrice` | `string` | -| `BatteryA` | `string` | -| `BatteryA_to` | `string` | -| `BatteryCells` | `string` | -| `BatteryInfo` | `string` | -| `BatteryKWh` | `string` | -| `BatteryKWh_to` | `string` | -| `BatteryModules` | `string` | -| `BatteryPacks` | `string` | -| `BatteryType` | `string` | -| `BatteryV` | `string` | -| `BatteryV_to` | `string` | -| `BedLengthIN` | `string` | -| `BedType` | `string` | -| `BlindSpotIntervention` | `string` | -| `BlindSpotMon` | `string` | -| `BodyCabType` | `string` | -| `BodyClass` | `string` | -| `BrakeSystemDesc` | `string` | -| `BrakeSystemType` | `string` | -| `BusFloorConfigType` | `string` | -| `BusLength` | `string` | -| `BusType` | `string` | -| `CAN_AACN` | `string` | -| `CIB` | `string` | -| `CashForClunkers` | `string` | -| `ChargerLevel` | `string` | -| `ChargerPowerKW` | `string` | -| `CoolingType` | `string` | -| `CurbWeightLB` | `string` | -| `CustomMotorcycleType` | `string` | -| `DaytimeRunningLight` | `string` | -| `DestinationMarket` | `string` | -| `DisplacementCC` | `string` | -| `DisplacementCI` | `string` | -| `DisplacementL` | `string` | -| `Doors` | `string` | -| `DriveType` | `string` | -| `DriverAssist` | `string` | -| `DynamicBrakeSupport` | `string` | -| `EDR` | `string` | -| `ESC` | `string` | -| `EVDriveUnit` | `string` | -| `ElectrificationLevel` | `string` | -| `EngineConfiguration` | `string` | -| `EngineCycles` | `string` | -| `EngineCylinders` | `string` | -| `EngineHP` | `string` | -| `EngineHP_to` | `string` | -| `EngineKW` | `string` | -| `EngineManufacturer` | `string` | -| `EngineModel` | `string` | -| `EntertainmentSystem` | `string` | -| `ErrorCode` | `string` | -| `ErrorText` | `string` | -| `ForwardCollisionWarning` | `string` | -| `FuelInjectionType` | `string` | -| `FuelTypePrimary` | `string` | -| `FuelTypeSecondary` | `string` | -| `GCWR` | `string` | -| `GCWR_to` | `string` | -| `GVWR` | `string` | -| `GVWR_to` | `string` | -| `KeylessIgnition` | `string` | -| `LaneCenteringAssistance` | `string` | -| `LaneDepartureWarning` | `string` | -| `LaneKeepSystem` | `string` | -| `LowerBeamHeadlampLightSource` | `string` | -| `Make` | `string` | -| `MakeID` | `string` | -| `Manufacturer` | `string` | -| `ManufacturerId` | `string` | -| `Model` | `string` | -| `ModelID` | `string` | -| `ModelYear` | `string` | -| `MotorcycleChassisType` | `string` | -| `MotorcycleSuspensionType` | `string` | -| `NCSABodyType` | `string` | -| `NCSAMake` | `string` | -| `NCSAMapExcApprovedBy` | `string` | -| `NCSAMapExcApprovedOn` | `string` | -| `NCSAMappingException` | `string` | -| `NCSAModel` | `string` | -| `NCSANote` | `string` | -| `NonLandUse` | `string` | -| `Note` | `string` | -| `OtherBusInfo` | `string` | -| `OtherEngineInfo` | `string` | -| `OtherMotorcycleInfo` | `string` | -| `OtherRestraintSystemInfo` | `string` | -| `OtherTrailerInfo` | `string` | -| `ParkAssist` | `string` | -| `PedestrianAutomaticEmergencyBraking` | `string` | -| `PlantCity` | `string` | -| `PlantCompanyName` | `string` | -| `PlantCountry` | `string` | -| `PlantState` | `string` | -| `PossibleValues` | `string` | -| `Pretensioner` | `string` | -| `RearAutomaticEmergencyBraking` | `string` | -| `RearCrossTrafficAlert` | `string` | -| `RearVisibilitySystem` | `string` | -| `SAEAutomationLevel` | `string` | -| `SAEAutomationLevel_to` | `string` | -| `SeatBeltsAll` | `string` | -| `SeatRows` | `string` | -| `Seats` | `string` | -| `SemiautomaticHeadlampBeamSwitching` | `string` | -| `Series` | `string` | -| `Series2` | `string` | -| `SteeringLocation` | `string` | -| `SuggestedVIN` | `string` | -| `TPMS` | `string` | -| `TopSpeedMPH` | `string` | -| `TrackWidth` | `string` | -| `TractionControl` | `string` | -| `TrailerBodyType` | `string` | -| `TrailerLength` | `string` | -| `TrailerType` | `string` | -| `TransmissionSpeeds` | `string` | -| `TransmissionStyle` | `string` | -| `Trim` | `string` | -| `Trim2` | `string` | -| `Turbo` | `string` | -| `VIN` | `string` | -| `ValveTrainDesign` | `string` | -| `VehicleDescriptor` | `string` | -| `VehicleType` | `string` | -| `WheelBaseLong` | `string` | -| `WheelBaseShort` | `string` | -| `WheelBaseType` | `string` | -| `WheelSizeFront` | `string` | -| `WheelSizeRear` | `string` | -| `Wheels` | `string` | -| `Windows` | `string` | - -#### Defined in - -[api/endpoints/DecodeVinValuesExtended.ts:117](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValuesExtended.ts#L117) - -## Functions - -### DecodeVinValuesExtended - -▸ **DecodeVinValuesExtended**(`vin`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeVinValuesExtendedResults`](api_endpoints_DecodeVinValuesExtended.md#decodevinvaluesextendedresults)\>\> - -::: tip :bulb: More Information -See: [DecodeVinValuesExtended Documentation](/api/endpoints/decode-vin-values-extended) -::: - -`DecodeVinValuesExtended` decodes a Vehicle Identification Number (VIN) and returns useful -information about the vehicle in in a _flat format_. This means the endpoint will return an -array with a single object of results. Each key in the object is the name of a variable. - -This endpoint is similar to `DecodeVinValues` but returns additional information on variables -related to other NHTSA programs like -[NCSA](https://www.nhtsa.gov/research-data/national-center-statistics-and-analysis-ncsa), etc. - -Providing `params.modelYear` allows for the decoding to specifically be done in the current, or -older (pre-1980), model year ranges. It is recommended to always provide `params.modelYear` if -the model year is known at the time of decoding, but it is not required. - -This endpoint also supports partial VIN decoding (VINs that are less than 17 characters). - -- Ex: "5UXWX7C5\*BA" -- In this case, the VIN will be decoded partially with the available characters -- In case of partial VINs, a `*` could be used to indicate the unavailable characters -- The 9th digit is not necessary - -#### Parameters - -| Name | Type | Description | -| :---- | :------- | :---------------------------------------------- | -| `vin` | `string` | Vehicle Identification Number (full or partial) | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeVinValuesExtendedResults`](api_endpoints_DecodeVinValuesExtended.md#decodevinvaluesextendedresults)\>\> - -- Api Response - `object` -or- url `string` if `doFetch = false` - -#### Defined in - -[api/endpoints/DecodeVinValuesExtended.ts:41](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValuesExtended.ts#L41) - -▸ **DecodeVinValuesExtended**(`vin`, `doFetch`, `_dummy?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeVinValuesExtendedResults`](api_endpoints_DecodeVinValuesExtended.md#decodevinvaluesextendedresults)\>\> - -#### Parameters - -| Name | Type | -| :-------- | :---------- | -| `vin` | `string` | -| `doFetch` | `true` | -| `_dummy?` | `undefined` | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeVinValuesExtendedResults`](api_endpoints_DecodeVinValuesExtended.md#decodevinvaluesextendedresults)\>\> - -#### Defined in - -[api/endpoints/DecodeVinValuesExtended.ts:45](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValuesExtended.ts#L45) - -▸ **DecodeVinValuesExtended**(`vin`, `doFetch`, `_dummy?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :---------- | -| `vin` | `string` | -| `doFetch` | `false` | -| `_dummy?` | `undefined` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/DecodeVinValuesExtended.ts:51](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValuesExtended.ts#L51) - -▸ **DecodeVinValuesExtended**(`vin`, `params`, `doFetch`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------------ | :------------------- | -| `vin` | `string` | -| `params` | `Object` | -| `params.modelYear?` | `string` \| `number` | -| `doFetch` | `false` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/DecodeVinValuesExtended.ts:57](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValuesExtended.ts#L57) - -▸ **DecodeVinValuesExtended**(`vin`, `params?`, `doFetch?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeVinValuesExtendedResults`](api_endpoints_DecodeVinValuesExtended.md#decodevinvaluesextendedresults)\>\> - -#### Parameters - -| Name | Type | -| :------------------ | :------------------- | -| `vin` | `string` | -| `params?` | `Object` | -| `params.modelYear?` | `string` \| `number` | -| `doFetch?` | `true` | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeVinValuesExtendedResults`](api_endpoints_DecodeVinValuesExtended.md#decodevinvaluesextendedresults)\>\> - -#### Defined in - -[api/endpoints/DecodeVinValuesExtended.ts:63](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeVinValuesExtended.ts#L63) diff --git a/apps/docs/src/typedoc/modules/api_endpoints_DecodeWMI.md b/apps/docs/src/typedoc/modules/api_endpoints_DecodeWMI.md deleted file mode 100644 index 494a0ad9..00000000 --- a/apps/docs/src/typedoc/modules/api_endpoints_DecodeWMI.md +++ /dev/null @@ -1,96 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/endpoints/DecodeWMI - -# Module: api/endpoints/DecodeWMI - -## Table of contents - -### Type Aliases - -- [DecodeWMIResults](api_endpoints_DecodeWMI.md#decodewmiresults) - -### Functions - -- [DecodeWMI](api_endpoints_DecodeWMI.md#decodewmi) - -## Type Aliases - -### DecodeWMIResults - -Ƭ **DecodeWMIResults**: `Object` - -Objects found in the `Results` array of `DecodeWMI` endpoint response. - -#### Type declaration - -| Name | Type | -| :---------------------- | :----------------- | -| `CommonName` | `string` | -| `CreatedOn` | `string` | -| `DateAvailableToPublic` | `string` | -| `Make` | `string` | -| `ManufacturerName` | `string` | -| `ParentCompanyName` | `string` | -| `URL` | `string` | -| `UpdatedOn` | `string` \| `null` | -| `VehicleType` | `string` | - -#### Defined in - -[api/endpoints/DecodeWMI.ts:76](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeWMI.ts#L76) - -## Functions - -### DecodeWMI - -▸ **DecodeWMI**(`WMI`, `doFetch?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeWMIResults`](api_endpoints_DecodeWMI.md#decodewmiresults)\>\> - -::: tip :bulb: More Information -See: [DecodeWMI Documentation](/api/endpoints/decode-wmi) -::: - -`DecodeWMI` provides information on the World Manufacturer Identifier for a specific `WMI` code. - -`WMI` may be provided as either 3 characters representing VIN position 1-3 _or_ 6 characters -representing VIN positions 1-3 & 12-14. - -- Examples: "JTD" "1T9131" - -A list of WMI codes can be found -[here](), -but keep in mind that not all of the listed WMIs are registered with NHTSA and therefore may not -be available in VPIC data sets. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :----------------------------------------------------------------- | -| `WMI` | `string` | World Manufacturer Identifier | -| `doFetch?` | `true` | Whether to fetch the data or just return the URL (default: `true`) | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`DecodeWMIResults`](api_endpoints_DecodeWMI.md#decodewmiresults)\>\> - -- Api Response `object` - -or- url `string` if `doFetch = false` (default: `true`) - -#### Defined in - -[api/endpoints/DecodeWMI.ts:32](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeWMI.ts#L32) - -▸ **DecodeWMI**(`WMI`, `doFetch`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------- | -| `WMI` | `string` | -| `doFetch` | `false` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/DecodeWMI.ts:37](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/DecodeWMI.ts#L37) diff --git a/apps/docs/src/typedoc/modules/api_endpoints_GetAllMakes.md b/apps/docs/src/typedoc/modules/api_endpoints_GetAllMakes.md deleted file mode 100644 index 8ca21729..00000000 --- a/apps/docs/src/typedoc/modules/api_endpoints_GetAllMakes.md +++ /dev/null @@ -1,81 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/endpoints/GetAllMakes - -# Module: api/endpoints/GetAllMakes - -## Table of contents - -### Type Aliases - -- [GetAllMakesResults](api_endpoints_GetAllMakes.md#getallmakesresults) - -### Functions - -- [GetAllMakes](api_endpoints_GetAllMakes.md#getallmakes) - -## Type Aliases - -### GetAllMakesResults - -Ƭ **GetAllMakesResults**: `Object` - -Objects found in the `Results` array of `GetAllMakes` endpoint response. - -#### Type declaration - -| Name | Type | -| :---------- | :------- | -| `Make_ID` | `number` | -| `Make_Name` | `string` | - -#### Defined in - -[api/endpoints/GetAllMakes.ts:56](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetAllMakes.ts#L56) - -## Functions - -### GetAllMakes - -▸ **GetAllMakes**(`doFetch?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetAllMakesResults`](api_endpoints_GetAllMakes.md#getallmakesresults)\>\> - -::: tip :bulb: More Information -See: [GetAllMakes Documentation](/api/endpoints/get-all-makes) -::: - -`GetAllMakes` provides a list of all the Makes available in the vPIC Dataset. -Each object in the `Results` array represents the `Make_ID` and the `Make_Name` of -an individual vehicle Make. - -- FYI there are over 10,000 registered makes in the database! - -#### Parameters - -| Name | Type | Description | -| :--------- | :----- | :----------------------------------------------------------------- | -| `doFetch?` | `true` | Whether to fetch the data or just return the URL (default: `true`) | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetAllMakesResults`](api_endpoints_GetAllMakes.md#getallmakesresults)\>\> - -- Api Response `object` - -or- url `string` if `doFetch = false` (default: `true`) - -#### Defined in - -[api/endpoints/GetAllMakes.ts:26](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetAllMakes.ts#L26) - -▸ **GetAllMakes**(`doFetch`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `doFetch` | `false` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/GetAllMakes.ts:28](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetAllMakes.ts#L28) diff --git a/apps/docs/src/typedoc/modules/api_endpoints_GetAllManufacturers.md b/apps/docs/src/typedoc/modules/api_endpoints_GetAllManufacturers.md deleted file mode 100644 index 2b68736e..00000000 --- a/apps/docs/src/typedoc/modules/api_endpoints_GetAllManufacturers.md +++ /dev/null @@ -1,128 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/endpoints/GetAllManufacturers - -# Module: api/endpoints/GetAllManufacturers - -## Table of contents - -### Type Aliases - -- [GetAllManufacturersResults](api_endpoints_GetAllManufacturers.md#getallmanufacturersresults) - -### Functions - -- [GetAllManufacturers](api_endpoints_GetAllManufacturers.md#getallmanufacturers) - -## Type Aliases - -### GetAllManufacturersResults - -Ƭ **GetAllManufacturersResults**: `Object` - -Objects found in the `Results` array of `GetAllManufacturers` endpoint response. - -#### Type declaration - -| Name | Type | -| :--------------- | :------------------------------------------------ | -| `Country` | `string` | -| `Mfr_CommonName` | `string` \| `null` | -| `Mfr_ID` | `number` | -| `Mfr_Name` | `string` | -| `VehicleTypes` | { `IsPrimary?`: `boolean` ; `Name?`: `string` }[] | - -#### Defined in - -[api/endpoints/GetAllManufacturers.ts:111](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetAllManufacturers.ts#L111) - -## Functions - -### GetAllManufacturers - -▸ **GetAllManufacturers**(`doFetch?`, `_dummy?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetAllManufacturersResults`](api_endpoints_GetAllManufacturers.md#getallmanufacturersresults)\>\> - -::: tip :bulb: More Information -See: [GetAllManufacturers Documentation](/api/endpoints/get-all-manufacturers) -::: - -`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 - -| Name | Type | Description | -| :--------- | :---------- | :----------------------------------------------------------------- | -| `doFetch?` | `true` | Whether to fetch the data or just return the URL (default: `true`) | -| `_dummy?` | `undefined` | - | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetAllManufacturersResults`](api_endpoints_GetAllManufacturers.md#getallmanufacturersresults)\>\> - -- Api Response `object` - -or- url `string` if `doFetch = false` - -#### Defined in - -[api/endpoints/GetAllManufacturers.ts:33](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetAllManufacturers.ts#L33) - -▸ **GetAllManufacturers**(`doFetch?`, `_dummy?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :--------- | :---------- | -| `doFetch?` | `false` | -| `_dummy?` | `undefined` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/GetAllManufacturers.ts:38](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetAllManufacturers.ts#L38) - -▸ **GetAllManufacturers**(`params`, `doFetch`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------------------- | :------------------- | -| `params` | `Object` | -| `params.manufacturerType?` | `string` | -| `params.page?` | `string` \| `number` | -| `doFetch` | `false` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/GetAllManufacturers.ts:43](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetAllManufacturers.ts#L43) - -▸ **GetAllManufacturers**(`params?`, `doFetch?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetAllManufacturersResults`](api_endpoints_GetAllManufacturers.md#getallmanufacturersresults)\>\> - -#### Parameters - -| Name | Type | -| :------------------------- | :------------------- | -| `params?` | `Object` | -| `params.manufacturerType?` | `string` | -| `params.page?` | `string` \| `number` | -| `doFetch?` | `true` | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetAllManufacturersResults`](api_endpoints_GetAllManufacturers.md#getallmanufacturersresults)\>\> - -#### Defined in - -[api/endpoints/GetAllManufacturers.ts:51](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetAllManufacturers.ts#L51) diff --git a/apps/docs/src/typedoc/modules/api_endpoints_GetCanadianVehicleSpecifications.md b/apps/docs/src/typedoc/modules/api_endpoints_GetCanadianVehicleSpecifications.md deleted file mode 100644 index c739d159..00000000 --- a/apps/docs/src/typedoc/modules/api_endpoints_GetCanadianVehicleSpecifications.md +++ /dev/null @@ -1,103 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/endpoints/GetCanadianVehicleSpecifications - -# Module: api/endpoints/GetCanadianVehicleSpecifications - -## Table of contents - -### Type Aliases - -- [GetCanadianVehicleSpecificationsResults](api_endpoints_GetCanadianVehicleSpecifications.md#getcanadianvehiclespecificationsresults) - -### Functions - -- [GetCanadianVehicleSpecifications](api_endpoints_GetCanadianVehicleSpecifications.md#getcanadianvehiclespecifications) - -## Type Aliases - -### GetCanadianVehicleSpecificationsResults - -Ƭ **GetCanadianVehicleSpecificationsResults**: `Object` - -Objects found in the `Results` array of `GetCanadianVehicleSpecifications` endpoint response. - -#### Type declaration - -| Name | Type | -| :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Specs` | { `Name`: `"Make"` \| `"Model"` \| `"MYR"` \| `"OL"` \| `"OW"` \| `"OH"` \| `"WB"` \| `"CW"` \| `"A"` \| `"B"` \| `"C"` \| `"D"` \| `"E"` \| `"F"` \| `"G"` \| `"TWF"` \| `"TWR"` \| `"WD"` ; `Value`: `string` }[] | - -#### Defined in - -[api/endpoints/GetCanadianVehicleSpecifications.ts:120](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetCanadianVehicleSpecifications.ts#L120) - -## Functions - -### GetCanadianVehicleSpecifications - -▸ **GetCanadianVehicleSpecifications**(`params`, `doFetch?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetCanadianVehicleSpecificationsResults`](api_endpoints_GetCanadianVehicleSpecifications.md#getcanadianvehiclespecificationsresults)\>\> - -::: tip :bulb: More Information -See: [GetCanadianVehicleSpecifications Documentation](/api/endpoints/get-canadian-vehicle-specifications) -::: - -`GetCanadianVehicleSpecifications` returns data from the Canadian Vehicle Specifications (CVS). -The CVS consists of a database of original vehicle dimensions, used primarily in -collision investigation and reconstruction, combined with a search engine. - -The CVS database is compiled annually by the Collision Investigation and Research Division of -Transport Canada. Visit official -[Canadian Vehicle Specifications](http://www.carsp.ca/research/resources/safety-sources/canadian-vehicle-specifications/) -page for more details. - -`params.year` is the only required query parameter, all others are optional but will still be -included in the query string as blank values even if not provided by the user. -See below Note for more details. - -_NOTE:_ This endpoint does not like missing query keys and will return a 404 error if any of -them are omitted from the query string. Therefore, we must set default values to empty strings -for any query keys that are not provided by the user. This means keys not provided by user will -always show up as "something=" in the query string. `year` is the only key user must provide, -no default value is set for it so that an error will be thrown if not provided by user. - -#### Parameters - -| Name | Type | Description | -| :-------------- | :------------------- | :--------------------------------------------------------------------------------------------------------------------- | -| `params` | `Object` | Object of Query Search names and values to append to the URL as a query string | -| `params.make?` | `string` | Vehicle's make, like "Honda", "Toyota", etc... | -| `params.model?` | `string` | Vehicle's model, like "Pilot", "Focus". Can also include some other elements like Body Type, Engine Model/size, etc... | -| `params.units?` | `string` | "Metric" (default), or "US" for standard units | -| `params.year` | `string` \| `number` | Model year of the vehicle - year >= 1971 | -| `doFetch?` | `true` | Whether to fetch the data or just return the URL (default: `true`) | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetCanadianVehicleSpecificationsResults`](api_endpoints_GetCanadianVehicleSpecifications.md#getcanadianvehiclespecificationsresults)\>\> - -- Api - Response `object` -or- url `string` if `doFetch = false` - -#### Defined in - -[api/endpoints/GetCanadianVehicleSpecifications.ts:45](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetCanadianVehicleSpecifications.ts#L45) - -▸ **GetCanadianVehicleSpecifications**(`params`, `doFetch`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------------- | :------------------- | -| `params` | `Object` | -| `params.make?` | `string` | -| `params.model?` | `string` | -| `params.units?` | `string` | -| `params.year` | `string` \| `number` | -| `doFetch` | `false` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/GetCanadianVehicleSpecifications.ts:55](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetCanadianVehicleSpecifications.ts#L55) diff --git a/apps/docs/src/typedoc/modules/api_endpoints_GetEquipmentPlantCodes.md b/apps/docs/src/typedoc/modules/api_endpoints_GetEquipmentPlantCodes.md deleted file mode 100644 index a103a35f..00000000 --- a/apps/docs/src/typedoc/modules/api_endpoints_GetEquipmentPlantCodes.md +++ /dev/null @@ -1,131 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/endpoints/GetEquipmentPlantCodes - -# Module: api/endpoints/GetEquipmentPlantCodes - -## Table of contents - -### Type Aliases - -- [GetEquipmentPlantCodesParams](api_endpoints_GetEquipmentPlantCodes.md#getequipmentplantcodesparams) -- [GetEquipmentPlantCodesResults](api_endpoints_GetEquipmentPlantCodes.md#getequipmentplantcodesresults) - -### Functions - -- [GetEquipmentPlantCodes](api_endpoints_GetEquipmentPlantCodes.md#getequipmentplantcodes) - -## Type Aliases - -### GetEquipmentPlantCodesParams - -Ƭ **GetEquipmentPlantCodesParams**: `Object` - -Query String Parameters for this endpoint - -#### Type declaration - -| Name | Type | -| :-------------- | :------------------------------------------------------------------------------------------------- | -| `equipmentType` | `"1"` \| `"3"` \| `"13"` \| `"16"` \| `1` \| `3` \| `13` \| `16` | -| `reportType` | `"New"` \| `"Updated"` \| `"Closed"` \| `"All"` \| `"new"` \| `"updated"` \| `"closed"` \| `"all"` | -| `year` | `string` \| `number` | - -#### Defined in - -[api/endpoints/GetEquipmentPlantCodes.ts:105](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetEquipmentPlantCodes.ts#L105) - ---- - -### GetEquipmentPlantCodesResults - -Ƭ **GetEquipmentPlantCodesResults**: `Object` - -Objects found in the `Results` array of `GetEquipmentPlantCodes` endpoint response. - -#### Type declaration - -| Name | Type | -| :-------------- | :----------------- | -| `Address` | `string` \| `null` | -| `City` | `string` \| `null` | -| `Country` | `string` | -| `DOTCode` | `string` | -| `Name` | `string` | -| `OldDotCode` | `string` | -| `PostalCode` | `string` \| `null` | -| `StateProvince` | `string` \| `null` | -| `Status` | `string` \| `null` | - -#### Defined in - -[api/endpoints/GetEquipmentPlantCodes.ts:122](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetEquipmentPlantCodes.ts#L122) - -## Functions - -### GetEquipmentPlantCodes - -▸ **GetEquipmentPlantCodes**(`params`, `doFetch?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetEquipmentPlantCodesResults`](api_endpoints_GetEquipmentPlantCodes.md#getequipmentplantcodesresults)\>\> - -::: tip :bulb: More Information -See: [GetEquipmentPlantCodes Documentation](/api/endpoints/get-equipment-plant-codes) -::: - -`GetEquipmentPlantCodes` returns assigned Equipment Plant Codes. Can be filtered by Year, -Equipment Type and Report Type. - -ALL parameters are required and endpoint will return 404 if there are any undefined keys and/or -values in the query string. - -`params.equipmentType`: - -- 1 (Tires) -- 3 (Brake Hoses) -- 13 (Glazing) -- 16 (Retread) - -`params.reportType`: - -- 'New' (The Equipment Plant Code was assigned during the selected year) -- 'Updated' (The Equipment Plant data was modified during the selected year) -- 'Closed' (The Equipment Plant is no longer Active) -- 'All' (All Equipment Plant Codes regardless of year, including their status (active or closed)) - -`params.year`: - -- year >= 2016 -- NOTE: It seems API will still respond with years < 2016 but api docs state only years >= 2016 - are supported - -#### Parameters - -| Name | Type | Description | -| :--------- | :----------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------- | -| `params` | [`GetEquipmentPlantCodesParams`](api_endpoints_GetEquipmentPlantCodes.md#getequipmentplantcodesparams) | Object of Query Search names and values to append to the URL as a query string | -| `doFetch?` | `true` | Whether to fetch the data or just return the URL (default: `true`) | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetEquipmentPlantCodesResults`](api_endpoints_GetEquipmentPlantCodes.md#getequipmentplantcodesresults)\>\> - -- Api Response - `object` -or- url `string` if `doFetch = false` - -#### Defined in - -[api/endpoints/GetEquipmentPlantCodes.ts:47](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetEquipmentPlantCodes.ts#L47) - -▸ **GetEquipmentPlantCodes**(`params`, `doFetch`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------------------------- | -| `params` | [`GetEquipmentPlantCodesParams`](api_endpoints_GetEquipmentPlantCodes.md#getequipmentplantcodesparams) | -| `doFetch` | `false` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/GetEquipmentPlantCodes.ts:52](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetEquipmentPlantCodes.ts#L52) diff --git a/apps/docs/src/typedoc/modules/api_endpoints_GetMakeForManufacturer.md b/apps/docs/src/typedoc/modules/api_endpoints_GetMakeForManufacturer.md deleted file mode 100644 index 6a5daeda..00000000 --- a/apps/docs/src/typedoc/modules/api_endpoints_GetMakeForManufacturer.md +++ /dev/null @@ -1,88 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/endpoints/GetMakeForManufacturer - -# Module: api/endpoints/GetMakeForManufacturer - -## Table of contents - -### Type Aliases - -- [GetMakeForManufacturerResults](api_endpoints_GetMakeForManufacturer.md#getmakeformanufacturerresults) - -### Functions - -- [GetMakeForManufacturer](api_endpoints_GetMakeForManufacturer.md#getmakeformanufacturer) - -## Type Aliases - -### GetMakeForManufacturerResults - -Ƭ **GetMakeForManufacturerResults**: `Object` - -Objects found in the `Results` array of `GetMakeForManufacturer` endpoint response. - -#### Type declaration - -| Name | Type | -| :---------- | :------- | -| `Make_ID` | `number` | -| `Make_Name` | `string` | -| `Mfr_Name` | `string` | - -#### Defined in - -[api/endpoints/GetMakeForManufacturer.ts:77](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetMakeForManufacturer.ts#L77) - -## Functions - -### GetMakeForManufacturer - -▸ **GetMakeForManufacturer**(`manufacturer`, `doFetch?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetMakeForManufacturerResults`](api_endpoints_GetMakeForManufacturer.md#getmakeformanufacturerresults)\>\> - -::: tip :bulb: More Information -See: [GetMakeForManufacturer Documentation](/api/endpoints/get-make-for-manufacturer) -::: - -`GetMakeForManufacturer` returns all the Makes in the vPIC dataset for a specified manufacturer -that is requested. Multiple results are returned in case of multiple matches. - -`manufacturer` name can be a partial name, or a full name for more specificity, e.g. "988", -"honda", "HONDA OF CANADA MFG., INC.", etc. - -- If supplied `manufacturer` is a number - method will do exact match on Manufacturer's Id. -- If supplied `manufacturer` is a string - it will look for manufacturers whose name is LIKE the - provided name. It accepts a partial manufacturer name as an input. - -#### Parameters - -| Name | Type | Description | -| :------------- | :------------------- | :----------------------------------------------------------------- | -| `manufacturer` | `string` \| `number` | Manufacturer Name or ID | -| `doFetch?` | `true` | Whether to fetch the data or just return the URL (default: `true`) | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetMakeForManufacturerResults`](api_endpoints_GetMakeForManufacturer.md#getmakeformanufacturerresults)\>\> - -- Api Response - `object` -or- url `string` if `doFetch = false` - -#### Defined in - -[api/endpoints/GetMakeForManufacturer.ts:31](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetMakeForManufacturer.ts#L31) - -▸ **GetMakeForManufacturer**(`manufacturer`, `doFetch`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------- | :------------------- | -| `manufacturer` | `string` \| `number` | -| `doFetch` | `false` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/GetMakeForManufacturer.ts:36](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetMakeForManufacturer.ts#L36) diff --git a/apps/docs/src/typedoc/modules/api_endpoints_GetMakesForManufacturerAndYear.md b/apps/docs/src/typedoc/modules/api_endpoints_GetMakesForManufacturerAndYear.md deleted file mode 100644 index 994df9e1..00000000 --- a/apps/docs/src/typedoc/modules/api_endpoints_GetMakesForManufacturerAndYear.md +++ /dev/null @@ -1,103 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/endpoints/GetMakesForManufacturerAndYear - -# Module: api/endpoints/GetMakesForManufacturerAndYear - -## Table of contents - -### Type Aliases - -- [GetMakesForManufacturerAndYearResults](api_endpoints_GetMakesForManufacturerAndYear.md#getmakesformanufacturerandyearresults) - -### Functions - -- [GetMakesForManufacturerAndYear](api_endpoints_GetMakesForManufacturerAndYear.md#getmakesformanufacturerandyear) - -## Type Aliases - -### GetMakesForManufacturerAndYearResults - -Ƭ **GetMakesForManufacturerAndYearResults**: `Object` - -Objects found in the `Results` array of `GetMakesForManufacturerAndYear` endpoint response. - -#### Type declaration - -| Name | Type | -| :--------- | :------- | -| `MakeId` | `number` | -| `MakeName` | `string` | -| `MfrId` | `number` | -| `MfrName` | `string` | - -#### Defined in - -[api/endpoints/GetMakesForManufacturerAndYear.ts:105](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetMakesForManufacturerAndYear.ts#L105) - -## Functions - -### GetMakesForManufacturerAndYear - -▸ **GetMakesForManufacturerAndYear**(`manufacturer`, `params`, `doFetch?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetMakesForManufacturerAndYearResults`](api_endpoints_GetMakesForManufacturerAndYear.md#getmakesformanufacturerandyearresults)\>\> - -::: tip :bulb: More Information -See: [GetMakesForManufacturerAndYear Documentation](/api/endpoints/get-makes-for-manufacturer-and-year) -::: - -`GetMakesForManufacturerAndYear` returns all the Makes in the vPIC dataset for a specified -`manufacturer`, and whose "Year From" and "Year To" range cover the specified `year`. Multiple -results are returned in case of multiple matches. - -Both `manufacturer` and `params.year` are required. - -`manufacturer` name can be a partial name, or a full name for more specificity, e.g. "988", -"honda", "HONDA OF CANADA MFG., INC.", etc. - -- If supplied `manufacturer` is a number - method will do exact match on Manufacturer's Id. -- If supplied `manufacturer` is a string - it will look for manufacturers whose name is LIKE the - provided name. It accepts a partial manufacturer name as an input. - -`params.year` must be a number > 2016, years prior to 2016 are not supported according to the -NHTSA API. During testing it was found that the API still returns data for years prior to 2016. - -::: warning :exclamation: Required Parameters -Both `manufacturer` and `params.year` are required. -::: - -#### Parameters - -| Name | Type | Description | -| :------------- | :------------------- | :----------------------------------------------------------------------------- | -| `manufacturer` | `string` \| `number` | Manufacturer Name (string) or Manufacturer ID (number) | -| `params` | `Object` | Object of Query Search names and values to append to the URL as a query string | -| `params.year` | `string` \| `number` | Model year of the vehicle - Number, >= 2016 | -| `doFetch?` | `true` | Whether to fetch the data or just return the URL (default: `true`) | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetMakesForManufacturerAndYearResults`](api_endpoints_GetMakesForManufacturerAndYear.md#getmakesformanufacturerandyearresults)\>\> - -- Api - Response `object` -or- url `string` if `doFetch = false` - -#### Defined in - -[api/endpoints/GetMakesForManufacturerAndYear.ts:43](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetMakesForManufacturerAndYear.ts#L43) - -▸ **GetMakesForManufacturerAndYear**(`manufacturer`, `params`, `doFetch`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------- | :------------------- | -| `manufacturer` | `string` \| `number` | -| `params` | `Object` | -| `params.year` | `string` \| `number` | -| `doFetch` | `false` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/GetMakesForManufacturerAndYear.ts:49](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetMakesForManufacturerAndYear.ts#L49) diff --git a/apps/docs/src/typedoc/modules/api_endpoints_GetMakesForVehicleType.md b/apps/docs/src/typedoc/modules/api_endpoints_GetMakesForVehicleType.md deleted file mode 100644 index 824df589..00000000 --- a/apps/docs/src/typedoc/modules/api_endpoints_GetMakesForVehicleType.md +++ /dev/null @@ -1,85 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/endpoints/GetMakesForVehicleType - -# Module: api/endpoints/GetMakesForVehicleType - -## Table of contents - -### Type Aliases - -- [GetMakesForVehicleTypeResults](api_endpoints_GetMakesForVehicleType.md#getmakesforvehicletyperesults) - -### Functions - -- [GetMakesForVehicleType](api_endpoints_GetMakesForVehicleType.md#getmakesforvehicletype) - -## Type Aliases - -### GetMakesForVehicleTypeResults - -Ƭ **GetMakesForVehicleTypeResults**: `Object` - -Objects found in the `Results` array of `GetMakesForVehicleType` endpoint response. - -#### Type declaration - -| Name | Type | -| :---------------- | :------- | -| `MakeId` | `number` | -| `MakeName` | `string` | -| `VehicleTypeId` | `number` | -| `VehicleTypeName` | `string` | - -#### Defined in - -[api/endpoints/GetMakesForVehicleType.ts:73](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetMakesForVehicleType.ts#L73) - -## Functions - -### GetMakesForVehicleType - -▸ **GetMakesForVehicleType**(`typeName`, `doFetch?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetMakesForVehicleTypeResults`](api_endpoints_GetMakesForVehicleType.md#getmakesforvehicletyperesults)\>\> - -::: tip :bulb: More Information -See: [GetMakesForVehicleType Documentation](/api/endpoints/get-makes-for-vehicle-type) -::: - -`GetMakesForVehicleType` returns all the Makes in the vPIC dataset for a specified vehicle type -(`typeName`), whose name is LIKE the vehicle type name in vPIC Dataset. - -`typeName` can be a partial name, or a full name for more specificity, e.g., "Vehicle", "Moto", -"Low Speed Vehicle", etc. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :----------------------------------------------------------------- | -| `typeName` | `string` | A partial or full vehicle type name | -| `doFetch?` | `true` | Whether to fetch the data or just return the URL (default: `true`) | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetMakesForVehicleTypeResults`](api_endpoints_GetMakesForVehicleType.md#getmakesforvehicletyperesults)\>\> - -- Api Response - `object` -or- url `string` if `doFetch = false` - -#### Defined in - -[api/endpoints/GetMakesForVehicleType.ts:27](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetMakesForVehicleType.ts#L27) - -▸ **GetMakesForVehicleType**(`typeName`, `doFetch`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :--------- | :------- | -| `typeName` | `string` | -| `doFetch` | `false` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/GetMakesForVehicleType.ts:32](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetMakesForVehicleType.ts#L32) diff --git a/apps/docs/src/typedoc/modules/api_endpoints_GetManufacturerDetails.md b/apps/docs/src/typedoc/modules/api_endpoints_GetManufacturerDetails.md deleted file mode 100644 index 15577187..00000000 --- a/apps/docs/src/typedoc/modules/api_endpoints_GetManufacturerDetails.md +++ /dev/null @@ -1,110 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/endpoints/GetManufacturerDetails - -# Module: api/endpoints/GetManufacturerDetails - -## Table of contents - -### Type Aliases - -- [GetManufacturerDetailsResults](api_endpoints_GetManufacturerDetails.md#getmanufacturerdetailsresults) - -### Functions - -- [GetManufacturerDetails](api_endpoints_GetManufacturerDetails.md#getmanufacturerdetails) - -## Type Aliases - -### GetManufacturerDetailsResults - -Ƭ **GetManufacturerDetailsResults**: `Object` - -Objects found in the `Results` array of `GetManufacturerDetails` endpoint response. - -#### Type declaration - -| Name | Type | -| :------------------------- | :------------------------------------------------------------------------------------------ | -| `Address` | `string` \| `null` | -| `Address2` | `string` \| `null` | -| `City` | `string` \| `null` | -| `ContactEmail` | `string` \| `null` | -| `ContactFax` | `string` \| `null` | -| `ContactPhone` | `string` \| `null` | -| `Country` | `string` \| `null` | -| `DBAs` | `string` \| `null` | -| `EquipmentItems` | `unknown`[] | -| `LastUpdated` | `string` | -| `ManufacturerTypes` | { `Name`: `string` }[] | -| `Mfr_CommonName` | `string` \| `null` | -| `Mfr_ID` | `number` \| `null` | -| `Mfr_Name` | `string` \| `null` | -| `OtherManufacturerDetails` | `string` \| `null` | -| `PostalCode` | `string` \| `null` | -| `PrimaryProduct` | `string` \| `null` | -| `PrincipalFirstName` | `string` \| `null` | -| `PrincipalLastName` | `string` \| `null` | -| `PrincipalPosition` | `string` \| `null` | -| `StateProvince` | `string` \| `null` | -| `SubmittedName` | `string` \| `null` | -| `SubmittedOn` | `string` | -| `SubmittedPosition` | `string` \| `null` | -| `VehicleTypes` | { `GVWRFrom`: `string` ; `GVWRTo`: `string` ; `IsPrimary`: `boolean` ; `Name`: `string` }[] | - -#### Defined in - -[api/endpoints/GetManufacturerDetails.ts:77](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetManufacturerDetails.ts#L77) - -## Functions - -### GetManufacturerDetails - -▸ **GetManufacturerDetails**(`manufacturer`, `doFetch?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetManufacturerDetailsResults`](api_endpoints_GetManufacturerDetails.md#getmanufacturerdetailsresults)\>\> - -::: tip :bulb: More Information -See: [GetMakesForVehicleType Documentation](/api/endpoints/get-makes-for-vehicle-type) -::: - -`GetManufacturerDetails` provides the details for a specific manufacturer that is requested. -Multiple results are returned in case of multiple matches. - -`manufacturer` name can be a partial name, or a full name for more specificity, e.g. "988", -"honda", "HONDA OF CANADA MFG., INC.", etc. - -- If supplied `manufacturer` is a number - method will do exact match on Manufacturer's Id. -- If supplied `manufacturer` is a string - it will look for manufacturers whose name is LIKE the - provided name. It accepts a partial manufacturer name as an input. - -#### Parameters - -| Name | Type | Description | -| :------------- | :------------------- | :----------------------------------------------------------------- | -| `manufacturer` | `string` \| `number` | Manufacturer Name or ID | -| `doFetch?` | `true` | Whether to fetch the data or just return the URL (default: `true`) | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetManufacturerDetailsResults`](api_endpoints_GetManufacturerDetails.md#getmanufacturerdetailsresults)\>\> - -- Api Response - `object` -or- url `string` if `doFetch = false` - -#### Defined in - -[api/endpoints/GetManufacturerDetails.ts:31](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetManufacturerDetails.ts#L31) - -▸ **GetManufacturerDetails**(`manufacturer`, `doFetch`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------- | :------------------- | -| `manufacturer` | `string` \| `number` | -| `doFetch` | `false` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/GetManufacturerDetails.ts:36](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetManufacturerDetails.ts#L36) diff --git a/apps/docs/src/typedoc/modules/api_endpoints_GetModelsForMake.md b/apps/docs/src/typedoc/modules/api_endpoints_GetModelsForMake.md deleted file mode 100644 index 97012c4d..00000000 --- a/apps/docs/src/typedoc/modules/api_endpoints_GetModelsForMake.md +++ /dev/null @@ -1,87 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/endpoints/GetModelsForMake - -# Module: api/endpoints/GetModelsForMake - -## Table of contents - -### Type Aliases - -- [GetModelsForMakeResults](api_endpoints_GetModelsForMake.md#getmodelsformakeresults) - -### Functions - -- [GetModelsForMake](api_endpoints_GetModelsForMake.md#getmodelsformake) - -## Type Aliases - -### GetModelsForMakeResults - -Ƭ **GetModelsForMakeResults**: `Object` - -Objects found in the `Results` array of `GetModelsForMake` endpoint response. - -#### Type declaration - -| Name | Type | -| :----------- | :------- | -| `Make_ID` | `number` | -| `Make_Name` | `string` | -| `Model_ID` | `number` | -| `Model_Name` | `string` | - -#### Defined in - -[api/endpoints/GetModelsForMake.ts:71](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetModelsForMake.ts#L71) - -## Functions - -### GetModelsForMake - -▸ **GetModelsForMake**(`makeName`, `doFetch?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetModelsForMakeResults`](api_endpoints_GetModelsForMake.md#getmodelsformakeresults)\>\> - -::: tip :bulb: More Information -See: [GetModelsForMake Documentation](/api/endpoints/get-models-for-make) -::: - -`GetModelsForMake` returns the Models in the vPIC dataset for a specified `makeName` -whose Name is LIKE the Make in vPIC Dataset. - -`makeName` can be a partial, or a full for more specificity, e.g., "Harley", -"Harley Davidson", etc. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :----------------------------------------------------------------- | -| `makeName` | `string` | Vehicle make name | -| `doFetch?` | `true` | Whether to fetch the data or just return the URL (default: `true`) | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetModelsForMakeResults`](api_endpoints_GetModelsForMake.md#getmodelsformakeresults)\>\> - -- Api Response object - -- Api Response `object` - -or- url `string` if `doFetch = false` - -#### Defined in - -[api/endpoints/GetModelsForMake.ts:28](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetModelsForMake.ts#L28) - -▸ **GetModelsForMake**(`makeName`, `doFetch`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :--------- | :------- | -| `makeName` | `string` | -| `doFetch` | `false` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/GetModelsForMake.ts:33](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetModelsForMake.ts#L33) diff --git a/apps/docs/src/typedoc/modules/api_endpoints_GetModelsForMakeId.md b/apps/docs/src/typedoc/modules/api_endpoints_GetModelsForMakeId.md deleted file mode 100644 index b7e3239c..00000000 --- a/apps/docs/src/typedoc/modules/api_endpoints_GetModelsForMakeId.md +++ /dev/null @@ -1,102 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/endpoints/GetModelsForMakeId - -# Module: api/endpoints/GetModelsForMakeId - -## Table of contents - -### Type Aliases - -- [GetModelsForMakeIdResults](api_endpoints_GetModelsForMakeId.md#getmodelsformakeidresults) - -### Functions - -- [GetModelsForMakeId](api_endpoints_GetModelsForMakeId.md#getmodelsformakeid) - -## Type Aliases - -### GetModelsForMakeIdResults - -Ƭ **GetModelsForMakeIdResults**: `Object` - -Objects found in the `Results` array of `GetModelsForMakeId` endpoint response. - -#### Type declaration - -| Name | Type | -| :----------- | :------- | -| `Make_ID` | `number` | -| `Make_Name` | `string` | -| `Model_ID` | `number` | -| `Model_Name` | `string` | - -#### Defined in - -[api/endpoints/GetModelsForMakeId.ts:87](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetModelsForMakeId.ts#L87) - -## Functions - -### GetModelsForMakeId - -▸ **GetModelsForMakeId**(`makeId`, `doFetch?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetModelsForMakeIdResults`](api_endpoints_GetModelsForMakeId.md#getmodelsformakeidresults)\>\> - -::: tip :bulb: More Information -See: [GetModelsForMakeId Documentation](/api/endpoints/get-models-for-make-id) -::: - -`GetModelsForMakeId` returns the Models in the vPIC dataset for a specified Make whose ID is -equal to the `makeID` in the vPIC Dataset. - -You can get `makeID`s via `MAKE_ID` key in Results objects of the following endpoints: - -- `GetAllMakes` endpoint -- `GetMakeForManufacturer` endpoint -- `GetModelsForMake` endpoint -- `GetModelsForMakeYear` endpoint - -You can get `makeID`s via `MakeID` key in Results objects of the following endpoints: - -- `DecodeVinValues` -- `DecodeVinValuesBatch` - -You can get `makeID`s via `ValueId` key in Results objects of the following endpoints. -One of the objects in the `Results` array will contain both `Variable: "Make"` and -`VariableId: 26`. The `ValueId` key in that same object is the `makeID` for use in this -endpoint. - -- `DecodeVin` -- `DecodeVinExtended` - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------- | :----------------------------------------------------------------- | -| `makeId` | `string` \| `number` | Make ID to search | -| `doFetch?` | `true` | Whether to fetch the data or just return the URL (default: `true`) | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetModelsForMakeIdResults`](api_endpoints_GetModelsForMakeId.md#getmodelsformakeidresults)\>\> - -- Api Response `object` - -or- url `string` if `doFetch = false` - -#### Defined in - -[api/endpoints/GetModelsForMakeId.ts:41](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetModelsForMakeId.ts#L41) - -▸ **GetModelsForMakeId**(`makeId`, `doFetch`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------------------- | -| `makeId` | `string` \| `number` | -| `doFetch` | `false` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/GetModelsForMakeId.ts:46](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetModelsForMakeId.ts#L46) diff --git a/apps/docs/src/typedoc/modules/api_endpoints_GetParts.md b/apps/docs/src/typedoc/modules/api_endpoints_GetParts.md deleted file mode 100644 index 3ec3779d..00000000 --- a/apps/docs/src/typedoc/modules/api_endpoints_GetParts.md +++ /dev/null @@ -1,163 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/endpoints/GetParts - -# Module: api/endpoints/GetParts - -## Table of contents - -### Type Aliases - -- [GetPartsResults](api_endpoints_GetParts.md#getpartsresults) - -### Functions - -- [GetParts](api_endpoints_GetParts.md#getparts) - -## Type Aliases - -### GetPartsResults - -Ƭ **GetPartsResults**: `Object` - -Objects found in the `Results` array of `GetParts` endpoint response. - -#### Type declaration - -| Name | Type | -| :----------------- | :----------------- | -| `CoverLetterURL` | `string` | -| `LetterDate` | `string` | -| `ManufacturerId` | `number` | -| `ManufacturerName` | `string` | -| `ModelYearFrom` | `number` \| `null` | -| `ModelYearTo` | `number` \| `null` | -| `Name` | `string` | -| `Type` | `string` | -| `URL` | `string` | - -#### Defined in - -[api/endpoints/GetParts.ts:143](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetParts.ts#L143) - -## Functions - -### GetParts - -▸ **GetParts**(`doFetch?`, `_dummy?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetPartsResults`](api_endpoints_GetParts.md#getpartsresults)\>\> - -::: tip :bulb: More Information -See: [GetParts Documentation](/api/endpoints/get-parts) -::: - -`GetParts` provides a list of ORGs with letter date in the given range of the dates and with -specified Type (`params.type`) of ORG. - -- Up to 1000 results will be returned at a time. -- Get the next page by incrementing the `params.page` query parameter. - -All query `params` are optional. - -`params.manufacturer`: - -- (optional) if supplied value is a number - method will do exact match on Manufacturer's Id -- if supplied value is a string - it will look for manufacturers whose name is LIKE the provided - name -- it accepts a partial manufacturer name as an input -- multiple results are returned in case of multiple matches -- manufacturer name can be a partial name, or a full name for more specificity, e.g., "988", - "HONDA", "HONDA OF CANADA MFG., INC.", etc. - -`params.type`: - -- (optional) number, 565 (Vehicle Identification Number Guidance, based on 49 CFR Part 565) - or 566 (Manufacturer Identification – Reporting Requirements based on 49 CFR Part 566) - -`params.fromDate`: - -- (optional) ORG's Letter Date should be on or after this date - -`params.toDate`: - -- (optional) ORG's Letter Date should be on or before this date - -`params.page`: - -- (optional) number, 1 (default) first 1000 records, 2 - next 1000 records, etc - -#### Parameters - -| Name | Type | Description | -| :--------- | :---------- | :----------------------------------------------------------------- | -| `doFetch?` | `true` | Whether to fetch the data or just return the URL (default: `true`) | -| `_dummy?` | `undefined` | - | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetPartsResults`](api_endpoints_GetParts.md#getpartsresults)\>\> - -- Api Response `object` - -or- url `string` if `doFetch = false` - -#### Defined in - -[api/endpoints/GetParts.ts:60](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetParts.ts#L60) - -▸ **GetParts**(`doFetch?`, `_dummy?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :--------- | :---------- | -| `doFetch?` | `false` | -| `_dummy?` | `undefined` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/GetParts.ts:65](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetParts.ts#L65) - -▸ **GetParts**(`params`, `doFetch`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :--------------------- | :------------------- | -| `params` | `Object` | -| `params.fromDate?` | `string` | -| `params.manufacturer?` | `string` \| `number` | -| `params.page?` | `string` \| `number` | -| `params.toDate?` | `string` | -| `params.type?` | `565` \| `566` | -| `doFetch` | `false` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/GetParts.ts:67](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetParts.ts#L67) - -▸ **GetParts**(`params?`, `doFetch?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetPartsResults`](api_endpoints_GetParts.md#getpartsresults)\>\> - -#### Parameters - -| Name | Type | -| :--------------------- | :------------------- | -| `params?` | `Object` | -| `params.fromDate?` | `string` | -| `params.manufacturer?` | `string` \| `number` | -| `params.page?` | `string` \| `number` | -| `params.toDate?` | `string` | -| `params.type?` | `565` \| `566` | -| `doFetch?` | `true` | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetPartsResults`](api_endpoints_GetParts.md#getpartsresults)\>\> - -#### Defined in - -[api/endpoints/GetParts.ts:78](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetParts.ts#L78) diff --git a/apps/docs/src/typedoc/modules/api_endpoints_GetVehicleTypesForMake.md b/apps/docs/src/typedoc/modules/api_endpoints_GetVehicleTypesForMake.md deleted file mode 100644 index f3ba4cba..00000000 --- a/apps/docs/src/typedoc/modules/api_endpoints_GetVehicleTypesForMake.md +++ /dev/null @@ -1,85 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/endpoints/GetVehicleTypesForMake - -# Module: api/endpoints/GetVehicleTypesForMake - -## Table of contents - -### Type Aliases - -- [GetVehicleTypesForMakeResults](api_endpoints_GetVehicleTypesForMake.md#getvehicletypesformakeresults) - -### Functions - -- [GetVehicleTypesForMake](api_endpoints_GetVehicleTypesForMake.md#getvehicletypesformake) - -## Type Aliases - -### GetVehicleTypesForMakeResults - -Ƭ **GetVehicleTypesForMakeResults**: `Object` - -Objects found in the `Results` array of `GetVehicleTypesForMake` endpoint response. - -#### Type declaration - -| Name | Type | -| :---------------- | :------- | -| `MakeId` | `number` | -| `MakeName` | `string` | -| `VehicleTypeId` | `number` | -| `VehicleTypeName` | `string` | - -#### Defined in - -[api/endpoints/GetVehicleTypesForMake.ts:73](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetVehicleTypesForMake.ts#L73) - -## Functions - -### GetVehicleTypesForMake - -▸ **GetVehicleTypesForMake**(`makeName`, `doFetch?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetVehicleTypesForMakeResults`](api_endpoints_GetVehicleTypesForMake.md#getvehicletypesformakeresults)\>\> - -::: tip :bulb: More Information -See: [GetVehicleTypesForMake Documentation](/api/endpoints/get-vehicle-types-for-make) -::: - -`GetVehicleTypesForMake` returns all the Vehicle Types in the vPIC dataset for a specified Make, -whose name is LIKE the make name in the vPIC Dataset. - -`makeName` can be a partial name, or a full name for more specificity, e.g., "Merc", -"Mercedes Benz", etc. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :----------------------------------------------------------------- | -| `makeName` | `string` | Name of the vehicle make to search | -| `doFetch?` | `true` | Whether to fetch the data or just return the URL (default: `true`) | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetVehicleTypesForMakeResults`](api_endpoints_GetVehicleTypesForMake.md#getvehicletypesformakeresults)\>\> - -- Api Response - `object` -or- url `string` if `doFetch = false` - -#### Defined in - -[api/endpoints/GetVehicleTypesForMake.ts:27](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetVehicleTypesForMake.ts#L27) - -▸ **GetVehicleTypesForMake**(`makeName`, `doFetch`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :--------- | :------- | -| `makeName` | `string` | -| `doFetch` | `false` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/GetVehicleTypesForMake.ts:32](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetVehicleTypesForMake.ts#L32) diff --git a/apps/docs/src/typedoc/modules/api_endpoints_GetVehicleTypesForMakeId.md b/apps/docs/src/typedoc/modules/api_endpoints_GetVehicleTypesForMakeId.md deleted file mode 100644 index b1fde33f..00000000 --- a/apps/docs/src/typedoc/modules/api_endpoints_GetVehicleTypesForMakeId.md +++ /dev/null @@ -1,100 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/endpoints/GetVehicleTypesForMakeId - -# Module: api/endpoints/GetVehicleTypesForMakeId - -## Table of contents - -### Type Aliases - -- [GetVehicleTypesForMakeIdResults](api_endpoints_GetVehicleTypesForMakeId.md#getvehicletypesformakeidresults) - -### Functions - -- [GetVehicleTypesForMakeId](api_endpoints_GetVehicleTypesForMakeId.md#getvehicletypesformakeid) - -## Type Aliases - -### GetVehicleTypesForMakeIdResults - -Ƭ **GetVehicleTypesForMakeIdResults**: `Object` - -Objects found in the `Results` array of `GetVehicleTypesForMakeId` endpoint response. - -#### Type declaration - -| Name | Type | -| :---------------- | :------- | -| `VehicleTypeId` | `number` | -| `VehicleTypeName` | `string` | - -#### Defined in - -[api/endpoints/GetVehicleTypesForMakeId.ts:87](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetVehicleTypesForMakeId.ts#L87) - -## Functions - -### GetVehicleTypesForMakeId - -▸ **GetVehicleTypesForMakeId**(`makeId`, `doFetch?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetVehicleTypesForMakeIdResults`](api_endpoints_GetVehicleTypesForMakeId.md#getvehicletypesformakeidresults)\>\> - -::: tip :bulb: More Information -See: [GetVehicleTypesForMakeId Documentation](/api/endpoints/get-vehicle-types-for-make-id) -::: - -`GetVehicleTypesForMakeId` returns the Models in the vPIC dataset for a specified Make -whose ID is equal to the `makeID` in the vPIC Dataset. - -You can get `makeID`s via `MAKE_ID` key in Results objects of the following endpoints: - -- `GetAllMakes` endpoint -- `GetMakeForManufacturer` endpoint -- `GetModelsForMake` endpoint -- `GetModelsForMakeYear` endpoint - -You can get `makeID`s via `MakeID` key in Results objects of the following endpoints: - -- `DecodeVinValues` -- `DecodeVinValuesBatch` - -You can get `makeID`s via `ValueId` key in Results objects of the following endpoints. -One of the objects in the `Results` array will contain both `Variable: "Make"` and -`VariableId: 26`. The `ValueId` key in that same object is the `makeID` for use in this -endpoint. - -- `DecodeVin` -- `DecodeVinExtended` - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------- | :----------------------------------------------------------------- | -| `makeId` | `string` \| `number` | Make ID to search | -| `doFetch?` | `true` | Whether to fetch the data or just return the URL (default: `true`) | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetVehicleTypesForMakeIdResults`](api_endpoints_GetVehicleTypesForMakeId.md#getvehicletypesformakeidresults)\>\> - -- Api Response - `object` -or- url `string` if `doFetch = false` - -#### Defined in - -[api/endpoints/GetVehicleTypesForMakeId.ts:41](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetVehicleTypesForMakeId.ts#L41) - -▸ **GetVehicleTypesForMakeId**(`makeId`, `doFetch`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------------------- | -| `makeId` | `string` \| `number` | -| `doFetch` | `false` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/GetVehicleTypesForMakeId.ts:46](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetVehicleTypesForMakeId.ts#L46) diff --git a/apps/docs/src/typedoc/modules/api_endpoints_GetVehicleVariableList.md b/apps/docs/src/typedoc/modules/api_endpoints_GetVehicleVariableList.md deleted file mode 100644 index fb89f554..00000000 --- a/apps/docs/src/typedoc/modules/api_endpoints_GetVehicleVariableList.md +++ /dev/null @@ -1,81 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/endpoints/GetVehicleVariableList - -# Module: api/endpoints/GetVehicleVariableList - -## Table of contents - -### Type Aliases - -- [GetVehicleVariableListResults](api_endpoints_GetVehicleVariableList.md#getvehiclevariablelistresults) - -### Functions - -- [GetVehicleVariableList](api_endpoints_GetVehicleVariableList.md#getvehiclevariablelist) - -## 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](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetVehicleVariableList.ts#L54) - -## Functions - -### GetVehicleVariableList - -▸ **GetVehicleVariableList**(`doFetch?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetVehicleVariableListResults`](api_endpoints_GetVehicleVariableList.md#getvehiclevariablelistresults)\>\> - -::: tip :bulb: More Information -See: [GetVehicleVariableList Documentation](/api/endpoints/get-vehicle-variable-list) -::: - -`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`](api_types.md#nhtsaresponse)<[`GetVehicleVariableListResults`](api_endpoints_GetVehicleVariableList.md#getvehiclevariablelistresults)\>\> - -- Api Response - `object` -or- url `string` if `doFetch = false` - -#### Defined in - -[api/endpoints/GetVehicleVariableList.ts:23](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetVehicleVariableList.ts#L23) - -▸ **GetVehicleVariableList**(`doFetch`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `doFetch` | `false` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/GetVehicleVariableList.ts:27](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetVehicleVariableList.ts#L27) diff --git a/apps/docs/src/typedoc/modules/api_endpoints_GetVehicleVariableValuesList.md b/apps/docs/src/typedoc/modules/api_endpoints_GetVehicleVariableValuesList.md deleted file mode 100644 index 4e16476c..00000000 --- a/apps/docs/src/typedoc/modules/api_endpoints_GetVehicleVariableValuesList.md +++ /dev/null @@ -1,86 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/endpoints/GetVehicleVariableValuesList - -# Module: api/endpoints/GetVehicleVariableValuesList - -## Table of contents - -### Type Aliases - -- [GetVehicleVariableValuesListResults](api_endpoints_GetVehicleVariableValuesList.md#getvehiclevariablevalueslistresults) - -### Functions - -- [GetVehicleVariableValuesList](api_endpoints_GetVehicleVariableValuesList.md#getvehiclevariablevalueslist) - -## Type Aliases - -### GetVehicleVariableValuesListResults - -Ƭ **GetVehicleVariableValuesListResults**: `Object` - -Objects found in the `Results` array of `GetVehicleVariableValuesList` endpoint response. - -#### Type declaration - -| Name | Type | -| :------------ | :------- | -| `ElementName` | `string` | -| `Id` | `number` | -| `Name` | `string` | - -#### Defined in - -[api/endpoints/GetVehicleVariableValuesList.ts:75](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetVehicleVariableValuesList.ts#L75) - -## Functions - -### GetVehicleVariableValuesList - -▸ **GetVehicleVariableValuesList**(`variableValue`, `doFetch?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetVehicleVariableValuesListResults`](api_endpoints_GetVehicleVariableValuesList.md#getvehiclevariablevalueslistresults)\>\> - -::: tip :bulb: More Information -See: [GetVehicleVariableValuesList Documentation](/api/endpoints/get-vehicle-variable-values-list) -::: - -`GetVehicleVariableValuesList` provides a list of all the accepted values for a given variable -that are stored in the vPIC dataset. - -If `variableValue` is a string, it must use full name, not just part of it, e.g., -"Battery Type", not "Battery" - -`variableValue` can be also be a number, which is the ID of the variable, e.g., 1, 2, 3, etc. - -#### Parameters - -| Name | Type | Description | -| :-------------- | :------------------- | :----------------------------------------------------------------- | -| `variableValue` | `string` \| `number` | The variable you want to get a values list of | -| `doFetch?` | `true` | Whether to fetch the data or just return the URL (default: `true`) | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetVehicleVariableValuesListResults`](api_endpoints_GetVehicleVariableValuesList.md#getvehiclevariablevalueslistresults)\>\> - -- Api Response - `object` -or- url `string` if `doFetch = false` - -#### Defined in - -[api/endpoints/GetVehicleVariableValuesList.ts:29](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetVehicleVariableValuesList.ts#L29) - -▸ **GetVehicleVariableValuesList**(`variableValue`, `doFetch`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------------- | :------------------- | -| `variableValue` | `string` \| `number` | -| `doFetch` | `false` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/GetVehicleVariableValuesList.ts:34](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetVehicleVariableValuesList.ts#L34) diff --git a/apps/docs/src/typedoc/modules/api_endpoints_GetWMIsForManufacturer.md b/apps/docs/src/typedoc/modules/api_endpoints_GetWMIsForManufacturer.md deleted file mode 100644 index fd32b665..00000000 --- a/apps/docs/src/typedoc/modules/api_endpoints_GetWMIsForManufacturer.md +++ /dev/null @@ -1,108 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/endpoints/GetWMIsForManufacturer - -# Module: api/endpoints/GetWMIsForManufacturer - -## Table of contents - -### Type Aliases - -- [GetWMIsForManufacturerResults](api_endpoints_GetWMIsForManufacturer.md#getwmisformanufacturerresults) - -### Functions - -- [GetWMIsForManufacturer](api_endpoints_GetWMIsForManufacturer.md#getwmisformanufacturer) - -## Type Aliases - -### GetWMIsForManufacturerResults - -Ƭ **GetWMIsForManufacturerResults**: `Object` - -Objects found in the `Results` array of `GetWMIsForManufacturer` endpoint response. - -#### Type declaration - -| Name | Type | -| :---------------------- | :----------------- | -| `Country` | `string` \| `null` | -| `CreatedOn` | `string` | -| `DateAvailableToPublic` | `string` | -| `Id` | `number` | -| `Name` | `string` | -| `UpdatedOn` | `string` | -| `VehicleType` | `string` | -| `WMI` | `string` | - -#### Defined in - -[api/endpoints/GetWMIsForManufacturer.ts:123](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetWMIsForManufacturer.ts#L123) - -## Functions - -### GetWMIsForManufacturer - -▸ **GetWMIsForManufacturer**(`params?`, `doFetch?`): `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetWMIsForManufacturerResults`](api_endpoints_GetWMIsForManufacturer.md#getwmisformanufacturerresults)\>\> - -::: tip :bulb: More Information -See: [GetWMIsForManufacturer Documentation](/api/endpoints/get-wmis-for-manufacturer) -::: - -`GetWMIsForManufacturer` provides information on the World Manufacturer Identifier (WMI) for a -specified `manufacturer`. Only WMIs registered in vPICList are displayed. Multiple results are -returned in case of multiple matches. - -Both `manufacturer` and `vehicleType` are optional but at least one must be provided. - -`manufacturer` can be a partial name, or a full name for more specificity, or WMI ID number, -e.g., "Merc", "Mercedes Benz", 987, etc. - -- If `manufacturer` is a number - method will do exact match on Manufacturer's Id -- If `manufacturer` is a string - it will look for manufacturers whose name is LIKE the provided - name (it accepts a partial Manufacturer name as an input) - -`vehicleType` can be a string or number, e.g., "car", 1, etc. - -- If `vehicleType` is a number - method will do exact match on VehicleType's Id -- If `vehicleType` is a string - it will look for VehicleType whose name is LIKE the provided - name (it accepts a partial VehicleType name as an input). - -_NOTE_: For this endpoint, `manufacturer` is actually part of the path string, not a query param. -We include `manufacturer` in params as it's easier to type the function args using the -'AtLeastOne' type if they are placed in the same object (params). This can cause confusion as -it's not consistent with other endpoint methods where path string is the first arg, and the query -params are the second arg. - -#### Parameters - -| Name | Type | Description | -| :--------- | :--------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------- | -| `params?` | [`AtLeastOne`](utils_types.md#atleastone)<{ `manufacturer?`: `string` \| `number` ; `vehicleType?`: `string` \| `number` }\> | Object of Query Search names and values to append to the URL as a query string | -| `doFetch?` | `true` | Whether to fetch the data or just return the URL (default: `true`) | - -#### Returns - -`Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<[`GetWMIsForManufacturerResults`](api_endpoints_GetWMIsForManufacturer.md#getwmisformanufacturerresults)\>\> - -- Api Response - `object` -or- url `string` if `doFetch = false` - -#### Defined in - -[api/endpoints/GetWMIsForManufacturer.ts:48](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetWMIsForManufacturer.ts#L48) - -▸ **GetWMIsForManufacturer**(`params`, `doFetch`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------------------------------------- | -| `params` | [`AtLeastOne`](utils_types.md#atleastone)<{ `manufacturer?`: `string` \| `number` ; `vehicleType?`: `string` \| `number` }\> | -| `doFetch` | `false` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[api/endpoints/GetWMIsForManufacturer.ts:56](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/endpoints/GetWMIsForManufacturer.ts#L56) diff --git a/apps/docs/src/typedoc/modules/api_endpoints_types.md b/apps/docs/src/typedoc/modules/api_endpoints_types.md deleted file mode 100644 index 6d9de49c..00000000 --- a/apps/docs/src/typedoc/modules/api_endpoints_types.md +++ /dev/null @@ -1,197 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/endpoints/types - -# Module: api/endpoints/types - -## Table of contents - -### References - -- [DecodeVinExtendedResults](api_endpoints_types.md#decodevinextendedresults) -- [DecodeVinExtendedVariable](api_endpoints_types.md#decodevinextendedvariable) -- [DecodeVinResults](api_endpoints_types.md#decodevinresults) -- [DecodeVinValuesBatchResults](api_endpoints_types.md#decodevinvaluesbatchresults) -- [DecodeVinValuesExtendedResults](api_endpoints_types.md#decodevinvaluesextendedresults) -- [DecodeVinValuesResults](api_endpoints_types.md#decodevinvaluesresults) -- [DecodeVinVariable](api_endpoints_types.md#decodevinvariable) -- [DecodeWMIResults](api_endpoints_types.md#decodewmiresults) -- [GetAllMakesResults](api_endpoints_types.md#getallmakesresults) -- [GetAllManufacturersResults](api_endpoints_types.md#getallmanufacturersresults) -- [GetCanadianVehicleSpecificationsResults](api_endpoints_types.md#getcanadianvehiclespecificationsresults) -- [GetEquipmentPlantCodesParams](api_endpoints_types.md#getequipmentplantcodesparams) -- [GetEquipmentPlantCodesResults](api_endpoints_types.md#getequipmentplantcodesresults) -- [GetMakeForManufacturerResults](api_endpoints_types.md#getmakeformanufacturerresults) -- [GetMakesForManufacturerAndYearResults](api_endpoints_types.md#getmakesformanufacturerandyearresults) -- [GetMakesForVehicleTypeResults](api_endpoints_types.md#getmakesforvehicletyperesults) -- [GetManufacturerDetailsResults](api_endpoints_types.md#getmanufacturerdetailsresults) -- [GetModelsForMakeIdResults](api_endpoints_types.md#getmodelsformakeidresults) -- [GetModelsForMakeIdYearResults](api_endpoints_types.md#getmodelsformakeidyearresults) -- [GetModelsForMakeResults](api_endpoints_types.md#getmodelsformakeresults) -- [GetModelsForMakeYearResults](api_endpoints_types.md#getmodelsformakeyearresults) -- [GetPartsResults](api_endpoints_types.md#getpartsresults) -- [GetVehicleTypesForMakeIdResults](api_endpoints_types.md#getvehicletypesformakeidresults) -- [GetVehicleTypesForMakeResults](api_endpoints_types.md#getvehicletypesformakeresults) -- [GetVehicleVariableListResults](api_endpoints_types.md#getvehiclevariablelistresults) -- [GetVehicleVariableValuesListResults](api_endpoints_types.md#getvehiclevariablevalueslistresults) -- [GetWMIsForManufacturerResults](api_endpoints_types.md#getwmisformanufacturerresults) - -## References - -### DecodeVinExtendedResults - -Re-exports [DecodeVinExtendedResults](api_endpoints_DecodeVinExtended.md#decodevinextendedresults) - ---- - -### DecodeVinExtendedVariable - -Re-exports [DecodeVinExtendedVariable](api_endpoints_DecodeVinExtended.md#decodevinextendedvariable) - ---- - -### DecodeVinResults - -Re-exports [DecodeVinResults](api_endpoints_DecodeVin.md#decodevinresults) - ---- - -### DecodeVinValuesBatchResults - -Re-exports [DecodeVinValuesBatchResults](api_endpoints_DecodeVinValuesBatch.md#decodevinvaluesbatchresults) - ---- - -### DecodeVinValuesExtendedResults - -Re-exports [DecodeVinValuesExtendedResults](api_endpoints_DecodeVinValuesExtended.md#decodevinvaluesextendedresults) - ---- - -### DecodeVinValuesResults - -Re-exports [DecodeVinValuesResults](api_endpoints_DecodeVinValues.md#decodevinvaluesresults) - ---- - -### DecodeVinVariable - -Re-exports [DecodeVinVariable](api_endpoints_DecodeVin.md#decodevinvariable) - ---- - -### DecodeWMIResults - -Re-exports [DecodeWMIResults](api_endpoints_DecodeWMI.md#decodewmiresults) - ---- - -### GetAllMakesResults - -Re-exports [GetAllMakesResults](api_endpoints_GetAllMakes.md#getallmakesresults) - ---- - -### GetAllManufacturersResults - -Re-exports [GetAllManufacturersResults](api_endpoints_GetAllManufacturers.md#getallmanufacturersresults) - ---- - -### GetCanadianVehicleSpecificationsResults - -Re-exports [GetCanadianVehicleSpecificationsResults](api_endpoints_GetCanadianVehicleSpecifications.md#getcanadianvehiclespecificationsresults) - ---- - -### GetEquipmentPlantCodesParams - -Re-exports [GetEquipmentPlantCodesParams](api_endpoints_GetEquipmentPlantCodes.md#getequipmentplantcodesparams) - ---- - -### GetEquipmentPlantCodesResults - -Re-exports [GetEquipmentPlantCodesResults](api_endpoints_GetEquipmentPlantCodes.md#getequipmentplantcodesresults) - ---- - -### GetMakeForManufacturerResults - -Re-exports [GetMakeForManufacturerResults](api_endpoints_GetMakeForManufacturer.md#getmakeformanufacturerresults) - ---- - -### GetMakesForManufacturerAndYearResults - -Re-exports [GetMakesForManufacturerAndYearResults](api_endpoints_GetMakesForManufacturerAndYear.md#getmakesformanufacturerandyearresults) - ---- - -### GetMakesForVehicleTypeResults - -Re-exports [GetMakesForVehicleTypeResults](api_endpoints_GetMakesForVehicleType.md#getmakesforvehicletyperesults) - ---- - -### GetManufacturerDetailsResults - -Re-exports [GetManufacturerDetailsResults](api_endpoints_GetManufacturerDetails.md#getmanufacturerdetailsresults) - ---- - -### GetModelsForMakeIdResults - -Re-exports [GetModelsForMakeIdResults](api_endpoints_GetModelsForMakeId.md#getmodelsformakeidresults) - ---- - -### GetModelsForMakeIdYearResults - -Re-exports [GetModelsForMakeIdYearResults](api_endpoints_GetModelsForMakeIdYear.md#getmodelsformakeidyearresults) - ---- - -### GetModelsForMakeResults - -Re-exports [GetModelsForMakeResults](api_endpoints_GetModelsForMake.md#getmodelsformakeresults) - ---- - -### GetModelsForMakeYearResults - -Re-exports [GetModelsForMakeYearResults](api_endpoints_GetModelsForMakeYear.md#getmodelsformakeyearresults) - ---- - -### GetPartsResults - -Re-exports [GetPartsResults](api_endpoints_GetParts.md#getpartsresults) - ---- - -### GetVehicleTypesForMakeIdResults - -Re-exports [GetVehicleTypesForMakeIdResults](api_endpoints_GetVehicleTypesForMakeId.md#getvehicletypesformakeidresults) - ---- - -### GetVehicleTypesForMakeResults - -Re-exports [GetVehicleTypesForMakeResults](api_endpoints_GetVehicleTypesForMake.md#getvehicletypesformakeresults) - ---- - -### GetVehicleVariableListResults - -Re-exports [GetVehicleVariableListResults](api_endpoints_GetVehicleVariableList.md#getvehiclevariablelistresults) - ---- - -### GetVehicleVariableValuesListResults - -Re-exports [GetVehicleVariableValuesListResults](api_endpoints_GetVehicleVariableValuesList.md#getvehiclevariablevalueslistresults) - ---- - -### GetWMIsForManufacturerResults - -Re-exports [GetWMIsForManufacturerResults](api_endpoints_GetWMIsForManufacturer.md#getwmisformanufacturerresults) diff --git a/apps/docs/src/typedoc/modules/api_types.md b/apps/docs/src/typedoc/modules/api_types.md deleted file mode 100644 index e7a2a201..00000000 --- a/apps/docs/src/typedoc/modules/api_types.md +++ /dev/null @@ -1,235 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/types - -# Module: api/types - -## Table of contents - -### References - -- [CreateUrlOptions](api_types.md#createurloptions) -- [DecodeVinExtendedResults](api_types.md#decodevinextendedresults) -- [DecodeVinExtendedVariable](api_types.md#decodevinextendedvariable) -- [DecodeVinResults](api_types.md#decodevinresults) -- [DecodeVinValuesBatchResults](api_types.md#decodevinvaluesbatchresults) -- [DecodeVinValuesExtendedResults](api_types.md#decodevinvaluesextendedresults) -- [DecodeVinValuesResults](api_types.md#decodevinvaluesresults) -- [DecodeVinVariable](api_types.md#decodevinvariable) -- [DecodeWMIResults](api_types.md#decodewmiresults) -- [GetAllMakesResults](api_types.md#getallmakesresults) -- [GetAllManufacturersResults](api_types.md#getallmanufacturersresults) -- [GetCanadianVehicleSpecificationsResults](api_types.md#getcanadianvehiclespecificationsresults) -- [GetEquipmentPlantCodesParams](api_types.md#getequipmentplantcodesparams) -- [GetEquipmentPlantCodesResults](api_types.md#getequipmentplantcodesresults) -- [GetMakeForManufacturerResults](api_types.md#getmakeformanufacturerresults) -- [GetMakesForManufacturerAndYearResults](api_types.md#getmakesformanufacturerandyearresults) -- [GetMakesForVehicleTypeResults](api_types.md#getmakesforvehicletyperesults) -- [GetManufacturerDetailsResults](api_types.md#getmanufacturerdetailsresults) -- [GetModelsForMakeIdResults](api_types.md#getmodelsformakeidresults) -- [GetModelsForMakeIdYearResults](api_types.md#getmodelsformakeidyearresults) -- [GetModelsForMakeResults](api_types.md#getmodelsformakeresults) -- [GetModelsForMakeYearResults](api_types.md#getmodelsformakeyearresults) -- [GetPartsResults](api_types.md#getpartsresults) -- [GetVehicleTypesForMakeIdResults](api_types.md#getvehicletypesformakeidresults) -- [GetVehicleTypesForMakeResults](api_types.md#getvehicletypesformakeresults) -- [GetVehicleVariableListResults](api_types.md#getvehiclevariablelistresults) -- [GetVehicleVariableValuesListResults](api_types.md#getvehiclevariablevalueslistresults) -- [GetWMIsForManufacturerResults](api_types.md#getwmisformanufacturerresults) - -### Type Aliases - -- [NhtsaResponse](api_types.md#nhtsaresponse) - -## References - -### CreateUrlOptions - -Re-exports [CreateUrlOptions](api_useNHTSA.md#createurloptions) - ---- - -### DecodeVinExtendedResults - -Re-exports [DecodeVinExtendedResults](api_endpoints_DecodeVinExtended.md#decodevinextendedresults) - ---- - -### DecodeVinExtendedVariable - -Re-exports [DecodeVinExtendedVariable](api_endpoints_DecodeVinExtended.md#decodevinextendedvariable) - ---- - -### DecodeVinResults - -Re-exports [DecodeVinResults](api_endpoints_DecodeVin.md#decodevinresults) - ---- - -### DecodeVinValuesBatchResults - -Re-exports [DecodeVinValuesBatchResults](api_endpoints_DecodeVinValuesBatch.md#decodevinvaluesbatchresults) - ---- - -### DecodeVinValuesExtendedResults - -Re-exports [DecodeVinValuesExtendedResults](api_endpoints_DecodeVinValuesExtended.md#decodevinvaluesextendedresults) - ---- - -### DecodeVinValuesResults - -Re-exports [DecodeVinValuesResults](api_endpoints_DecodeVinValues.md#decodevinvaluesresults) - ---- - -### DecodeVinVariable - -Re-exports [DecodeVinVariable](api_endpoints_DecodeVin.md#decodevinvariable) - ---- - -### DecodeWMIResults - -Re-exports [DecodeWMIResults](api_endpoints_DecodeWMI.md#decodewmiresults) - ---- - -### GetAllMakesResults - -Re-exports [GetAllMakesResults](api_endpoints_GetAllMakes.md#getallmakesresults) - ---- - -### GetAllManufacturersResults - -Re-exports [GetAllManufacturersResults](api_endpoints_GetAllManufacturers.md#getallmanufacturersresults) - ---- - -### GetCanadianVehicleSpecificationsResults - -Re-exports [GetCanadianVehicleSpecificationsResults](api_endpoints_GetCanadianVehicleSpecifications.md#getcanadianvehiclespecificationsresults) - ---- - -### GetEquipmentPlantCodesParams - -Re-exports [GetEquipmentPlantCodesParams](api_endpoints_GetEquipmentPlantCodes.md#getequipmentplantcodesparams) - ---- - -### GetEquipmentPlantCodesResults - -Re-exports [GetEquipmentPlantCodesResults](api_endpoints_GetEquipmentPlantCodes.md#getequipmentplantcodesresults) - ---- - -### GetMakeForManufacturerResults - -Re-exports [GetMakeForManufacturerResults](api_endpoints_GetMakeForManufacturer.md#getmakeformanufacturerresults) - ---- - -### GetMakesForManufacturerAndYearResults - -Re-exports [GetMakesForManufacturerAndYearResults](api_endpoints_GetMakesForManufacturerAndYear.md#getmakesformanufacturerandyearresults) - ---- - -### GetMakesForVehicleTypeResults - -Re-exports [GetMakesForVehicleTypeResults](api_endpoints_GetMakesForVehicleType.md#getmakesforvehicletyperesults) - ---- - -### GetManufacturerDetailsResults - -Re-exports [GetManufacturerDetailsResults](api_endpoints_GetManufacturerDetails.md#getmanufacturerdetailsresults) - ---- - -### GetModelsForMakeIdResults - -Re-exports [GetModelsForMakeIdResults](api_endpoints_GetModelsForMakeId.md#getmodelsformakeidresults) - ---- - -### GetModelsForMakeIdYearResults - -Re-exports [GetModelsForMakeIdYearResults](api_endpoints_GetModelsForMakeIdYear.md#getmodelsformakeidyearresults) - ---- - -### GetModelsForMakeResults - -Re-exports [GetModelsForMakeResults](api_endpoints_GetModelsForMake.md#getmodelsformakeresults) - ---- - -### GetModelsForMakeYearResults - -Re-exports [GetModelsForMakeYearResults](api_endpoints_GetModelsForMakeYear.md#getmodelsformakeyearresults) - ---- - -### GetPartsResults - -Re-exports [GetPartsResults](api_endpoints_GetParts.md#getpartsresults) - ---- - -### GetVehicleTypesForMakeIdResults - -Re-exports [GetVehicleTypesForMakeIdResults](api_endpoints_GetVehicleTypesForMakeId.md#getvehicletypesformakeidresults) - ---- - -### GetVehicleTypesForMakeResults - -Re-exports [GetVehicleTypesForMakeResults](api_endpoints_GetVehicleTypesForMake.md#getvehicletypesformakeresults) - ---- - -### GetVehicleVariableListResults - -Re-exports [GetVehicleVariableListResults](api_endpoints_GetVehicleVariableList.md#getvehiclevariablelistresults) - ---- - -### GetVehicleVariableValuesListResults - -Re-exports [GetVehicleVariableValuesListResults](api_endpoints_GetVehicleVariableValuesList.md#getvehiclevariablevalueslistresults) - ---- - -### GetWMIsForManufacturerResults - -Re-exports [GetWMIsForManufacturerResults](api_endpoints_GetWMIsForManufacturer.md#getwmisformanufacturerresults) - -## Type Aliases - -### NhtsaResponse - -Ƭ **NhtsaResponse**<`T`\>: `Object` - -Response data returned from the NHTSA VPIC API. `Results` key will be an array of objects of type "T" - -#### Type parameters - -| Name | -| :--- | -| `T` | - -#### Type declaration - -| Name | Type | Description | -| :--------------- | :----------------- | :-------------------------------------------------------------------------------------- | -| `Count` | `number` | The number of items returned in the Results object. Will = 0 if no Results | -| `Message` | `string` | A message describing the Results. If Count is 0 check the Message for helpful info | -| `Results` | `T`[] | An array of objects returned by NHTSA VPIC API, specific to each individual API Action. | -| `SearchCriteria` | `string` \| `null` | Search terms (VIN, WMI, etc) used in the request URL. | - -#### Defined in - -[api/types.ts:12](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/types.ts#L12) diff --git a/apps/docs/src/typedoc/modules/api_useNHTSA.md b/apps/docs/src/typedoc/modules/api_useNHTSA.md deleted file mode 100644 index 6795dc3d..00000000 --- a/apps/docs/src/typedoc/modules/api_useNHTSA.md +++ /dev/null @@ -1,83 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / api/useNHTSA - -# Module: api/useNHTSA - -## Table of contents - -### Type Aliases - -- [CreateUrlOptions](api_useNHTSA.md#createurloptions) - -### Functions - -- [useNHTSA](api_useNHTSA.md#usenhtsa) - -## Type Aliases - -### CreateUrlOptions - -Ƭ **CreateUrlOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :------------------------------------------------------------ | -| `allowEmptyParams?` | `boolean` | -| `endpointName` | `string` | -| `includeQueryString?` | `boolean` | -| `params?` | [`QueryStringParams`](utils_queryString.md#querystringparams) | -| `path?` | `string` | -| `saveUrl?` | `boolean` | - -#### Defined in - -[api/useNHTSA.ts:15](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/useNHTSA.ts#L15) - -## Functions - -### useNHTSA - -▸ **useNHTSA**(): `Object` - -`useNHTSA` returns a composable object containing helper functions for working with the VPIC -API. It is used internally by the package and by users to make direct requests to the VPIC API. - -It returns an object containing methods for making HTTP requests to the VPIC API. All -request methods return a Promise that resolves to an object containing the full response data. - -The functions returned by the composable are: - -- `createCachedUrl` - Builds the URL string and stores it in internal state - -- `getCachedUrl` - Gets the URL stored in internal state - -- `setCachedUrl` - Directly sets the URL internal state, does not check if URL is valid - -- `clearCachedUrl` - Clears the URL stored in internal state - -- `createUrl` - Returns a built URL string but does not store it in internal state - -- `createPostBody` - Creates a POST body string from an object of key/value pairs - -- `get` - Makes a GET request, uses the internal url variable if no URL is provided - -- `post` - Makes a POST request, uses the internal url variable if no URL is provided - -#### Returns - -`Object` - -| Name | Type | -| :---------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `clearCachedUrl` | () => `string` | -| `createCachedUrl` | (`input`: `string` \| [`CreateUrlOptions`](api_useNHTSA.md#createurloptions)) => `string` | -| `createPostBody` | (`data`: `string`) => `string` | -| `createUrl` | (`options`: [`CreateUrlOptions`](api_useNHTSA.md#createurloptions)) => `string` | -| `get` | (`url?`: `string` \| [`CreateUrlOptions`](api_useNHTSA.md#createurloptions), `options?`: `RequestInit` & { `saveUrl?`: `boolean` }) => `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<`T`\>\> | -| `getCachedUrl` | () => `string` | -| `post` | (`url?`: `string` \| [`CreateUrlOptions`](api_useNHTSA.md#createurloptions), `options?`: `RequestInit` & { `saveUrl?`: `boolean` }) => `Promise`<[`NhtsaResponse`](api_types.md#nhtsaresponse)<`T`\>\> | -| `setCachedUrl` | (`url`: `string`) => `string` | - -#### Defined in - -[api/useNHTSA.ts:50](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/api/useNHTSA.ts#L50) diff --git a/apps/docs/src/typedoc/modules/constants.md b/apps/docs/src/typedoc/modules/constants.md deleted file mode 100644 index aedfd958..00000000 --- a/apps/docs/src/typedoc/modules/constants.md +++ /dev/null @@ -1,30 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / constants - -# Module: constants - -## Table of contents - -### Variables - -- [NHTSA_BASE_URL](constants.md#nhtsa_base_url) -- [NHTSA_RESPONSE_FORMAT](constants.md#nhtsa_response_format) - -## Variables - -### NHTSA_BASE_URL - -• `Const` **NHTSA_BASE_URL**: `"https://vpic.nhtsa.dot.gov/api/vehicles"` - -#### Defined in - -[constants.ts:1](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/constants.ts#L1) - ---- - -### NHTSA_RESPONSE_FORMAT - -• `Const` **NHTSA_RESPONSE_FORMAT**: `"json"` - -#### Defined in - -[constants.ts:2](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/constants.ts#L2) diff --git a/apps/docs/src/typedoc/modules/global.md b/apps/docs/src/typedoc/modules/global.md deleted file mode 100644 index 952598ea..00000000 --- a/apps/docs/src/typedoc/modules/global.md +++ /dev/null @@ -1,3 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / global - -# Module: global diff --git a/apps/docs/src/typedoc/modules/index.md b/apps/docs/src/typedoc/modules/index.md deleted file mode 100644 index d1ed8a11..00000000 --- a/apps/docs/src/typedoc/modules/index.md +++ /dev/null @@ -1,449 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / index - -# Module: index - -## Table of contents - -### References - -- [AtLeastOne](index.md#atleastone) -- [CreateUrlOptions](index.md#createurloptions) -- [DecodeVin](index.md#decodevin) -- [DecodeVinExtended](index.md#decodevinextended) -- [DecodeVinExtendedResults](index.md#decodevinextendedresults) -- [DecodeVinExtendedVariable](index.md#decodevinextendedvariable) -- [DecodeVinResults](index.md#decodevinresults) -- [DecodeVinValues](index.md#decodevinvalues) -- [DecodeVinValuesBatch](index.md#decodevinvaluesbatch) -- [DecodeVinValuesBatchResults](index.md#decodevinvaluesbatchresults) -- [DecodeVinValuesExtended](index.md#decodevinvaluesextended) -- [DecodeVinValuesExtendedResults](index.md#decodevinvaluesextendedresults) -- [DecodeVinValuesResults](index.md#decodevinvaluesresults) -- [DecodeVinVariable](index.md#decodevinvariable) -- [DecodeWMI](index.md#decodewmi) -- [DecodeWMIResults](index.md#decodewmiresults) -- [GetAllMakes](index.md#getallmakes) -- [GetAllMakesResults](index.md#getallmakesresults) -- [GetAllManufacturers](index.md#getallmanufacturers) -- [GetAllManufacturersResults](index.md#getallmanufacturersresults) -- [GetCanadianVehicleSpecifications](index.md#getcanadianvehiclespecifications) -- [GetCanadianVehicleSpecificationsResults](index.md#getcanadianvehiclespecificationsresults) -- [GetEquipmentPlantCodes](index.md#getequipmentplantcodes) -- [GetEquipmentPlantCodesParams](index.md#getequipmentplantcodesparams) -- [GetEquipmentPlantCodesResults](index.md#getequipmentplantcodesresults) -- [GetMakeForManufacturer](index.md#getmakeformanufacturer) -- [GetMakeForManufacturerResults](index.md#getmakeformanufacturerresults) -- [GetMakesForManufacturerAndYear](index.md#getmakesformanufacturerandyear) -- [GetMakesForManufacturerAndYearResults](index.md#getmakesformanufacturerandyearresults) -- [GetMakesForVehicleType](index.md#getmakesforvehicletype) -- [GetMakesForVehicleTypeResults](index.md#getmakesforvehicletyperesults) -- [GetManufacturerDetails](index.md#getmanufacturerdetails) -- [GetManufacturerDetailsResults](index.md#getmanufacturerdetailsresults) -- [GetModelsForMake](index.md#getmodelsformake) -- [GetModelsForMakeId](index.md#getmodelsformakeid) -- [GetModelsForMakeIdResults](index.md#getmodelsformakeidresults) -- [GetModelsForMakeIdYear](index.md#getmodelsformakeidyear) -- [GetModelsForMakeIdYearResults](index.md#getmodelsformakeidyearresults) -- [GetModelsForMakeResults](index.md#getmodelsformakeresults) -- [GetModelsForMakeYear](index.md#getmodelsformakeyear) -- [GetModelsForMakeYearResults](index.md#getmodelsformakeyearresults) -- [GetParts](index.md#getparts) -- [GetPartsResults](index.md#getpartsresults) -- [GetVehicleTypesForMake](index.md#getvehicletypesformake) -- [GetVehicleTypesForMakeId](index.md#getvehicletypesformakeid) -- [GetVehicleTypesForMakeIdResults](index.md#getvehicletypesformakeidresults) -- [GetVehicleTypesForMakeResults](index.md#getvehicletypesformakeresults) -- [GetVehicleVariableList](index.md#getvehiclevariablelist) -- [GetVehicleVariableListResults](index.md#getvehiclevariablelistresults) -- [GetVehicleVariableValuesList](index.md#getvehiclevariablevalueslist) -- [GetVehicleVariableValuesListResults](index.md#getvehiclevariablevalueslistresults) -- [GetWMIsForManufacturer](index.md#getwmisformanufacturer) -- [GetWMIsForManufacturerResults](index.md#getwmisformanufacturerresults) -- [IArgToValidate](index.md#iargtovalidate) -- [NhtsaResponse](index.md#nhtsaresponse) -- [QueryStringParams](index.md#querystringparams) -- [QueryStringParamsEncoded](index.md#querystringparamsencoded) -- [QueryStringTypes](index.md#querystringtypes) -- [RequireOnlyOne](index.md#requireonlyone) -- [createQueryString](index.md#createquerystring) -- [encodeQueryStringParams](index.md#encodequerystringparams) -- [isValidVin](index.md#isvalidvin) -- [useNHTSA](index.md#usenhtsa) - -## References - -### AtLeastOne - -Re-exports [AtLeastOne](utils_types.md#atleastone) - ---- - -### CreateUrlOptions - -Re-exports [CreateUrlOptions](api_useNHTSA.md#createurloptions) - ---- - -### DecodeVin - -Re-exports [DecodeVin](api_endpoints_DecodeVin.md#decodevin) - ---- - -### DecodeVinExtended - -Re-exports [DecodeVinExtended](api_endpoints_DecodeVinExtended.md#decodevinextended) - ---- - -### DecodeVinExtendedResults - -Re-exports [DecodeVinExtendedResults](api_endpoints_DecodeVinExtended.md#decodevinextendedresults) - ---- - -### DecodeVinExtendedVariable - -Re-exports [DecodeVinExtendedVariable](api_endpoints_DecodeVinExtended.md#decodevinextendedvariable) - ---- - -### DecodeVinResults - -Re-exports [DecodeVinResults](api_endpoints_DecodeVin.md#decodevinresults) - ---- - -### DecodeVinValues - -Re-exports [DecodeVinValues](api_endpoints_DecodeVinValues.md#decodevinvalues) - ---- - -### DecodeVinValuesBatch - -Re-exports [DecodeVinValuesBatch](api_endpoints_DecodeVinValuesBatch.md#decodevinvaluesbatch) - ---- - -### DecodeVinValuesBatchResults - -Re-exports [DecodeVinValuesBatchResults](api_endpoints_DecodeVinValuesBatch.md#decodevinvaluesbatchresults) - ---- - -### DecodeVinValuesExtended - -Re-exports [DecodeVinValuesExtended](api_endpoints_DecodeVinValuesExtended.md#decodevinvaluesextended) - ---- - -### DecodeVinValuesExtendedResults - -Re-exports [DecodeVinValuesExtendedResults](api_endpoints_DecodeVinValuesExtended.md#decodevinvaluesextendedresults) - ---- - -### DecodeVinValuesResults - -Re-exports [DecodeVinValuesResults](api_endpoints_DecodeVinValues.md#decodevinvaluesresults) - ---- - -### DecodeVinVariable - -Re-exports [DecodeVinVariable](api_endpoints_DecodeVin.md#decodevinvariable) - ---- - -### DecodeWMI - -Re-exports [DecodeWMI](api_endpoints_DecodeWMI.md#decodewmi) - ---- - -### DecodeWMIResults - -Re-exports [DecodeWMIResults](api_endpoints_DecodeWMI.md#decodewmiresults) - ---- - -### GetAllMakes - -Re-exports [GetAllMakes](api_endpoints_GetAllMakes.md#getallmakes) - ---- - -### GetAllMakesResults - -Re-exports [GetAllMakesResults](api_endpoints_GetAllMakes.md#getallmakesresults) - ---- - -### GetAllManufacturers - -Re-exports [GetAllManufacturers](api_endpoints_GetAllManufacturers.md#getallmanufacturers) - ---- - -### GetAllManufacturersResults - -Re-exports [GetAllManufacturersResults](api_endpoints_GetAllManufacturers.md#getallmanufacturersresults) - ---- - -### GetCanadianVehicleSpecifications - -Re-exports [GetCanadianVehicleSpecifications](api_endpoints_GetCanadianVehicleSpecifications.md#getcanadianvehiclespecifications) - ---- - -### GetCanadianVehicleSpecificationsResults - -Re-exports [GetCanadianVehicleSpecificationsResults](api_endpoints_GetCanadianVehicleSpecifications.md#getcanadianvehiclespecificationsresults) - ---- - -### GetEquipmentPlantCodes - -Re-exports [GetEquipmentPlantCodes](api_endpoints_GetEquipmentPlantCodes.md#getequipmentplantcodes) - ---- - -### GetEquipmentPlantCodesParams - -Re-exports [GetEquipmentPlantCodesParams](api_endpoints_GetEquipmentPlantCodes.md#getequipmentplantcodesparams) - ---- - -### GetEquipmentPlantCodesResults - -Re-exports [GetEquipmentPlantCodesResults](api_endpoints_GetEquipmentPlantCodes.md#getequipmentplantcodesresults) - ---- - -### GetMakeForManufacturer - -Re-exports [GetMakeForManufacturer](api_endpoints_GetMakeForManufacturer.md#getmakeformanufacturer) - ---- - -### GetMakeForManufacturerResults - -Re-exports [GetMakeForManufacturerResults](api_endpoints_GetMakeForManufacturer.md#getmakeformanufacturerresults) - ---- - -### GetMakesForManufacturerAndYear - -Re-exports [GetMakesForManufacturerAndYear](api_endpoints_GetMakesForManufacturerAndYear.md#getmakesformanufacturerandyear) - ---- - -### GetMakesForManufacturerAndYearResults - -Re-exports [GetMakesForManufacturerAndYearResults](api_endpoints_GetMakesForManufacturerAndYear.md#getmakesformanufacturerandyearresults) - ---- - -### GetMakesForVehicleType - -Re-exports [GetMakesForVehicleType](api_endpoints_GetMakesForVehicleType.md#getmakesforvehicletype) - ---- - -### GetMakesForVehicleTypeResults - -Re-exports [GetMakesForVehicleTypeResults](api_endpoints_GetMakesForVehicleType.md#getmakesforvehicletyperesults) - ---- - -### GetManufacturerDetails - -Re-exports [GetManufacturerDetails](api_endpoints_GetManufacturerDetails.md#getmanufacturerdetails) - ---- - -### GetManufacturerDetailsResults - -Re-exports [GetManufacturerDetailsResults](api_endpoints_GetManufacturerDetails.md#getmanufacturerdetailsresults) - ---- - -### GetModelsForMake - -Re-exports [GetModelsForMake](api_endpoints_GetModelsForMake.md#getmodelsformake) - ---- - -### GetModelsForMakeId - -Re-exports [GetModelsForMakeId](api_endpoints_GetModelsForMakeId.md#getmodelsformakeid) - ---- - -### GetModelsForMakeIdResults - -Re-exports [GetModelsForMakeIdResults](api_endpoints_GetModelsForMakeId.md#getmodelsformakeidresults) - ---- - -### GetModelsForMakeIdYear - -Re-exports [GetModelsForMakeIdYear](api_endpoints_GetModelsForMakeIdYear.md#getmodelsformakeidyear) - ---- - -### GetModelsForMakeIdYearResults - -Re-exports [GetModelsForMakeIdYearResults](api_endpoints_GetModelsForMakeIdYear.md#getmodelsformakeidyearresults) - ---- - -### GetModelsForMakeResults - -Re-exports [GetModelsForMakeResults](api_endpoints_GetModelsForMake.md#getmodelsformakeresults) - ---- - -### GetModelsForMakeYear - -Re-exports [GetModelsForMakeYear](api_endpoints_GetModelsForMakeYear.md#getmodelsformakeyear) - ---- - -### GetModelsForMakeYearResults - -Re-exports [GetModelsForMakeYearResults](api_endpoints_GetModelsForMakeYear.md#getmodelsformakeyearresults) - ---- - -### GetParts - -Re-exports [GetParts](api_endpoints_GetParts.md#getparts) - ---- - -### GetPartsResults - -Re-exports [GetPartsResults](api_endpoints_GetParts.md#getpartsresults) - ---- - -### GetVehicleTypesForMake - -Re-exports [GetVehicleTypesForMake](api_endpoints_GetVehicleTypesForMake.md#getvehicletypesformake) - ---- - -### GetVehicleTypesForMakeId - -Re-exports [GetVehicleTypesForMakeId](api_endpoints_GetVehicleTypesForMakeId.md#getvehicletypesformakeid) - ---- - -### GetVehicleTypesForMakeIdResults - -Re-exports [GetVehicleTypesForMakeIdResults](api_endpoints_GetVehicleTypesForMakeId.md#getvehicletypesformakeidresults) - ---- - -### GetVehicleTypesForMakeResults - -Re-exports [GetVehicleTypesForMakeResults](api_endpoints_GetVehicleTypesForMake.md#getvehicletypesformakeresults) - ---- - -### GetVehicleVariableList - -Re-exports [GetVehicleVariableList](api_endpoints_GetVehicleVariableList.md#getvehiclevariablelist) - ---- - -### GetVehicleVariableListResults - -Re-exports [GetVehicleVariableListResults](api_endpoints_GetVehicleVariableList.md#getvehiclevariablelistresults) - ---- - -### GetVehicleVariableValuesList - -Re-exports [GetVehicleVariableValuesList](api_endpoints_GetVehicleVariableValuesList.md#getvehiclevariablevalueslist) - ---- - -### GetVehicleVariableValuesListResults - -Re-exports [GetVehicleVariableValuesListResults](api_endpoints_GetVehicleVariableValuesList.md#getvehiclevariablevalueslistresults) - ---- - -### GetWMIsForManufacturer - -Re-exports [GetWMIsForManufacturer](api_endpoints_GetWMIsForManufacturer.md#getwmisformanufacturer) - ---- - -### GetWMIsForManufacturerResults - -Re-exports [GetWMIsForManufacturerResults](api_endpoints_GetWMIsForManufacturer.md#getwmisformanufacturerresults) - ---- - -### IArgToValidate - -Re-exports [IArgToValidate](utils_argHandler.md#iargtovalidate) - ---- - -### NhtsaResponse - -Re-exports [NhtsaResponse](api_types.md#nhtsaresponse) - ---- - -### QueryStringParams - -Re-exports [QueryStringParams](utils_queryString.md#querystringparams) - ---- - -### QueryStringParamsEncoded - -Re-exports [QueryStringParamsEncoded](utils_queryString.md#querystringparamsencoded) - ---- - -### QueryStringTypes - -Re-exports [QueryStringTypes](utils_queryString.md#querystringtypes) - ---- - -### RequireOnlyOne - -Re-exports [RequireOnlyOne](utils_types.md#requireonlyone) - ---- - -### createQueryString - -Re-exports [createQueryString](utils_queryString.md#createquerystring) - ---- - -### encodeQueryStringParams - -Re-exports [encodeQueryStringParams](utils_queryString.md#encodequerystringparams) - ---- - -### isValidVin - -Re-exports [isValidVin](utils_isValidVin.md#isvalidvin) - ---- - -### useNHTSA - -Re-exports [useNHTSA](api_useNHTSA.md#usenhtsa) diff --git a/apps/docs/src/typedoc/modules/types.md b/apps/docs/src/typedoc/modules/types.md deleted file mode 100644 index ba55de09..00000000 --- a/apps/docs/src/typedoc/modules/types.md +++ /dev/null @@ -1,253 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / types - -# Module: types - -## Table of contents - -### References - -- [AtLeastOne](types.md#atleastone) -- [CreateUrlOptions](types.md#createurloptions) -- [DecodeVinExtendedResults](types.md#decodevinextendedresults) -- [DecodeVinExtendedVariable](types.md#decodevinextendedvariable) -- [DecodeVinResults](types.md#decodevinresults) -- [DecodeVinValuesBatchResults](types.md#decodevinvaluesbatchresults) -- [DecodeVinValuesExtendedResults](types.md#decodevinvaluesextendedresults) -- [DecodeVinValuesResults](types.md#decodevinvaluesresults) -- [DecodeVinVariable](types.md#decodevinvariable) -- [DecodeWMIResults](types.md#decodewmiresults) -- [GetAllMakesResults](types.md#getallmakesresults) -- [GetAllManufacturersResults](types.md#getallmanufacturersresults) -- [GetCanadianVehicleSpecificationsResults](types.md#getcanadianvehiclespecificationsresults) -- [GetEquipmentPlantCodesParams](types.md#getequipmentplantcodesparams) -- [GetEquipmentPlantCodesResults](types.md#getequipmentplantcodesresults) -- [GetMakeForManufacturerResults](types.md#getmakeformanufacturerresults) -- [GetMakesForManufacturerAndYearResults](types.md#getmakesformanufacturerandyearresults) -- [GetMakesForVehicleTypeResults](types.md#getmakesforvehicletyperesults) -- [GetManufacturerDetailsResults](types.md#getmanufacturerdetailsresults) -- [GetModelsForMakeIdResults](types.md#getmodelsformakeidresults) -- [GetModelsForMakeIdYearResults](types.md#getmodelsformakeidyearresults) -- [GetModelsForMakeResults](types.md#getmodelsformakeresults) -- [GetModelsForMakeYearResults](types.md#getmodelsformakeyearresults) -- [GetPartsResults](types.md#getpartsresults) -- [GetVehicleTypesForMakeIdResults](types.md#getvehicletypesformakeidresults) -- [GetVehicleTypesForMakeResults](types.md#getvehicletypesformakeresults) -- [GetVehicleVariableListResults](types.md#getvehiclevariablelistresults) -- [GetVehicleVariableValuesListResults](types.md#getvehiclevariablevalueslistresults) -- [GetWMIsForManufacturerResults](types.md#getwmisformanufacturerresults) -- [IArgToValidate](types.md#iargtovalidate) -- [NhtsaResponse](types.md#nhtsaresponse) -- [QueryStringParams](types.md#querystringparams) -- [QueryStringParamsEncoded](types.md#querystringparamsencoded) -- [QueryStringTypes](types.md#querystringtypes) -- [RequireOnlyOne](types.md#requireonlyone) - -## References - -### AtLeastOne - -Re-exports [AtLeastOne](utils_types.md#atleastone) - ---- - -### CreateUrlOptions - -Re-exports [CreateUrlOptions](api_useNHTSA.md#createurloptions) - ---- - -### DecodeVinExtendedResults - -Re-exports [DecodeVinExtendedResults](api_endpoints_DecodeVinExtended.md#decodevinextendedresults) - ---- - -### DecodeVinExtendedVariable - -Re-exports [DecodeVinExtendedVariable](api_endpoints_DecodeVinExtended.md#decodevinextendedvariable) - ---- - -### DecodeVinResults - -Re-exports [DecodeVinResults](api_endpoints_DecodeVin.md#decodevinresults) - ---- - -### DecodeVinValuesBatchResults - -Re-exports [DecodeVinValuesBatchResults](api_endpoints_DecodeVinValuesBatch.md#decodevinvaluesbatchresults) - ---- - -### DecodeVinValuesExtendedResults - -Re-exports [DecodeVinValuesExtendedResults](api_endpoints_DecodeVinValuesExtended.md#decodevinvaluesextendedresults) - ---- - -### DecodeVinValuesResults - -Re-exports [DecodeVinValuesResults](api_endpoints_DecodeVinValues.md#decodevinvaluesresults) - ---- - -### DecodeVinVariable - -Re-exports [DecodeVinVariable](api_endpoints_DecodeVin.md#decodevinvariable) - ---- - -### DecodeWMIResults - -Re-exports [DecodeWMIResults](api_endpoints_DecodeWMI.md#decodewmiresults) - ---- - -### GetAllMakesResults - -Re-exports [GetAllMakesResults](api_endpoints_GetAllMakes.md#getallmakesresults) - ---- - -### GetAllManufacturersResults - -Re-exports [GetAllManufacturersResults](api_endpoints_GetAllManufacturers.md#getallmanufacturersresults) - ---- - -### GetCanadianVehicleSpecificationsResults - -Re-exports [GetCanadianVehicleSpecificationsResults](api_endpoints_GetCanadianVehicleSpecifications.md#getcanadianvehiclespecificationsresults) - ---- - -### GetEquipmentPlantCodesParams - -Re-exports [GetEquipmentPlantCodesParams](api_endpoints_GetEquipmentPlantCodes.md#getequipmentplantcodesparams) - ---- - -### GetEquipmentPlantCodesResults - -Re-exports [GetEquipmentPlantCodesResults](api_endpoints_GetEquipmentPlantCodes.md#getequipmentplantcodesresults) - ---- - -### GetMakeForManufacturerResults - -Re-exports [GetMakeForManufacturerResults](api_endpoints_GetMakeForManufacturer.md#getmakeformanufacturerresults) - ---- - -### GetMakesForManufacturerAndYearResults - -Re-exports [GetMakesForManufacturerAndYearResults](api_endpoints_GetMakesForManufacturerAndYear.md#getmakesformanufacturerandyearresults) - ---- - -### GetMakesForVehicleTypeResults - -Re-exports [GetMakesForVehicleTypeResults](api_endpoints_GetMakesForVehicleType.md#getmakesforvehicletyperesults) - ---- - -### GetManufacturerDetailsResults - -Re-exports [GetManufacturerDetailsResults](api_endpoints_GetManufacturerDetails.md#getmanufacturerdetailsresults) - ---- - -### GetModelsForMakeIdResults - -Re-exports [GetModelsForMakeIdResults](api_endpoints_GetModelsForMakeId.md#getmodelsformakeidresults) - ---- - -### GetModelsForMakeIdYearResults - -Re-exports [GetModelsForMakeIdYearResults](api_endpoints_GetModelsForMakeIdYear.md#getmodelsformakeidyearresults) - ---- - -### GetModelsForMakeResults - -Re-exports [GetModelsForMakeResults](api_endpoints_GetModelsForMake.md#getmodelsformakeresults) - ---- - -### GetModelsForMakeYearResults - -Re-exports [GetModelsForMakeYearResults](api_endpoints_GetModelsForMakeYear.md#getmodelsformakeyearresults) - ---- - -### GetPartsResults - -Re-exports [GetPartsResults](api_endpoints_GetParts.md#getpartsresults) - ---- - -### GetVehicleTypesForMakeIdResults - -Re-exports [GetVehicleTypesForMakeIdResults](api_endpoints_GetVehicleTypesForMakeId.md#getvehicletypesformakeidresults) - ---- - -### GetVehicleTypesForMakeResults - -Re-exports [GetVehicleTypesForMakeResults](api_endpoints_GetVehicleTypesForMake.md#getvehicletypesformakeresults) - ---- - -### GetVehicleVariableListResults - -Re-exports [GetVehicleVariableListResults](api_endpoints_GetVehicleVariableList.md#getvehiclevariablelistresults) - ---- - -### GetVehicleVariableValuesListResults - -Re-exports [GetVehicleVariableValuesListResults](api_endpoints_GetVehicleVariableValuesList.md#getvehiclevariablevalueslistresults) - ---- - -### GetWMIsForManufacturerResults - -Re-exports [GetWMIsForManufacturerResults](api_endpoints_GetWMIsForManufacturer.md#getwmisformanufacturerresults) - ---- - -### IArgToValidate - -Re-exports [IArgToValidate](utils_argHandler.md#iargtovalidate) - ---- - -### NhtsaResponse - -Re-exports [NhtsaResponse](api_types.md#nhtsaresponse) - ---- - -### QueryStringParams - -Re-exports [QueryStringParams](utils_queryString.md#querystringparams) - ---- - -### QueryStringParamsEncoded - -Re-exports [QueryStringParamsEncoded](utils_queryString.md#querystringparamsencoded) - ---- - -### QueryStringTypes - -Re-exports [QueryStringTypes](utils_queryString.md#querystringtypes) - ---- - -### RequireOnlyOne - -Re-exports [RequireOnlyOne](utils_types.md#requireonlyone) diff --git a/apps/docs/src/typedoc/modules/utils.md b/apps/docs/src/typedoc/modules/utils.md deleted file mode 100644 index ee2cf5d9..00000000 --- a/apps/docs/src/typedoc/modules/utils.md +++ /dev/null @@ -1,71 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / utils - -# Module: utils - -## Table of contents - -### References - -- [catchInvalidArguments](utils.md#catchinvalidarguments) -- [createQueryString](utils.md#createquerystring) -- [encodeQueryStringParams](utils.md#encodequerystringparams) -- [getTypeof](utils.md#gettypeof) -- [handleError](utils.md#handleerror) -- [isError](utils.md#iserror) -- [isValidVin](utils.md#isvalidvin) -- [rejectWithError](utils.md#rejectwitherror) -- [validateArgument](utils.md#validateargument) - -## References - -### catchInvalidArguments - -Re-exports [catchInvalidArguments](utils_argHandler.md#catchinvalidarguments) - ---- - -### createQueryString - -Re-exports [createQueryString](utils_queryString.md#createquerystring) - ---- - -### encodeQueryStringParams - -Re-exports [encodeQueryStringParams](utils_queryString.md#encodequerystringparams) - ---- - -### getTypeof - -Re-exports [getTypeof](utils_getTypeof.md#gettypeof) - ---- - -### handleError - -Re-exports [handleError](utils_errorHandler.md#handleerror) - ---- - -### isError - -Re-exports [isError](utils_errorHandler.md#iserror) - ---- - -### isValidVin - -Re-exports [isValidVin](utils_isValidVin.md#isvalidvin) - ---- - -### rejectWithError - -Re-exports [rejectWithError](utils_errorHandler.md#rejectwitherror) - ---- - -### validateArgument - -Re-exports [validateArgument](utils_argHandler.md#validateargument) diff --git a/apps/docs/src/typedoc/modules/utils_types.md b/apps/docs/src/typedoc/modules/utils_types.md deleted file mode 100644 index 8f206988..00000000 --- a/apps/docs/src/typedoc/modules/utils_types.md +++ /dev/null @@ -1,81 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / utils/types - -# Module: utils/types - -## Table of contents - -### References - -- [IArgToValidate](utils_types.md#iargtovalidate) -- [QueryStringParams](utils_types.md#querystringparams) -- [QueryStringParamsEncoded](utils_types.md#querystringparamsencoded) -- [QueryStringTypes](utils_types.md#querystringtypes) - -### Type Aliases - -- [AtLeastOne](utils_types.md#atleastone) -- [RequireOnlyOne](utils_types.md#requireonlyone) - -## References - -### IArgToValidate - -Re-exports [IArgToValidate](utils_argHandler.md#iargtovalidate) - ---- - -### QueryStringParams - -Re-exports [QueryStringParams](utils_queryString.md#querystringparams) - ---- - -### QueryStringParamsEncoded - -Re-exports [QueryStringParamsEncoded](utils_queryString.md#querystringparamsencoded) - ---- - -### QueryStringTypes - -Re-exports [QueryStringTypes](utils_queryString.md#querystringtypes) - -## Type Aliases - -### AtLeastOne - -Ƭ **AtLeastOne**<`T`, `R`\>: { [P in R]-?: Required\> & Partial\> }[`R`] - -Require at least one of a set of properties in an object -https://stackoverflow.com/a/49725198 - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------- | -| `T` | `T` | -| `R` | extends keyof `T` = keyof `T` | - -#### Defined in - -[utils/types.ts:18](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/utils/types.ts#L18) - ---- - -### RequireOnlyOne - -Ƭ **RequireOnlyOne**<`T`, `Keys`\>: `Omit`<`T`, `Keys`\> & { [K in keyof Required]: Required\> & Partial, undefined\>\> }[`Keys`] - -Require only one of a set of properties in an object -https://stackoverflow.com/a/49725198 - -#### Type parameters - -| Name | Type | -| :----- | :---------------------------- | -| `T` | `T` | -| `Keys` | extends keyof `T` = keyof `T` | - -#### Defined in - -[utils/types.ts:26](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/utils/types.ts#L26) diff --git a/apps/docs/src/typedoc/modules/vite_env.md b/apps/docs/src/typedoc/modules/vite_env.md deleted file mode 100644 index d9621354..00000000 --- a/apps/docs/src/typedoc/modules/vite_env.md +++ /dev/null @@ -1,3 +0,0 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / vite-env - -# Module: vite-env diff --git a/apps/docs/src/typedoc/types.md b/apps/docs/src/typedoc/types.md new file mode 100644 index 00000000..996d813d --- /dev/null +++ b/apps/docs/src/typedoc/types.md @@ -0,0 +1,188 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](modules.md) / types + +# types + +## Contents + +- [References](types.md#references) + - [AtLeastOne](types.md#atleastone) + - [CreateUrlOptions](types.md#createurloptions) + - [DecodeVinExtendedResults](types.md#decodevinextendedresults) + - [DecodeVinExtendedVariable](types.md#decodevinextendedvariable) + - [DecodeVinResults](types.md#decodevinresults) + - [DecodeVinValuesBatchResults](types.md#decodevinvaluesbatchresults) + - [DecodeVinValuesExtendedResults](types.md#decodevinvaluesextendedresults) + - [DecodeVinValuesResults](types.md#decodevinvaluesresults) + - [DecodeVinVariable](types.md#decodevinvariable) + - [DecodeWMIResults](types.md#decodewmiresults) + - [GetAllMakesResults](types.md#getallmakesresults) + - [GetAllManufacturersResults](types.md#getallmanufacturersresults) + - [GetCanadianVehicleSpecificationsResults](types.md#getcanadianvehiclespecificationsresults) + - [GetEquipmentPlantCodesParams](types.md#getequipmentplantcodesparams) + - [GetEquipmentPlantCodesResults](types.md#getequipmentplantcodesresults) + - [GetMakeForManufacturerResults](types.md#getmakeformanufacturerresults) + - [GetMakesForManufacturerAndYearResults](types.md#getmakesformanufacturerandyearresults) + - [GetMakesForVehicleTypeResults](types.md#getmakesforvehicletyperesults) + - [GetManufacturerDetailsResults](types.md#getmanufacturerdetailsresults) + - [GetModelsForMakeIdResults](types.md#getmodelsformakeidresults) + - [GetModelsForMakeIdYearResults](types.md#getmodelsformakeidyearresults) + - [GetModelsForMakeResults](types.md#getmodelsformakeresults) + - [GetModelsForMakeYearResults](types.md#getmodelsformakeyearresults) + - [GetPartsResults](types.md#getpartsresults) + - [GetVehicleTypesForMakeIdResults](types.md#getvehicletypesformakeidresults) + - [GetVehicleTypesForMakeResults](types.md#getvehicletypesformakeresults) + - [GetVehicleVariableListResults](types.md#getvehiclevariablelistresults) + - [GetVehicleVariableValuesListResults](types.md#getvehiclevariablevalueslistresults) + - [GetWMIsForManufacturerResults](types.md#getwmisformanufacturerresults) + - [IArgToValidate](types.md#iargtovalidate) + - [NhtsaResponse](types.md#nhtsaresponse) + - [QueryStringParams](types.md#querystringparams) + - [QueryStringParamsEncoded](types.md#querystringparamsencoded) + - [QueryStringTypes](types.md#querystringtypes) + - [RequireOnlyOne](types.md#requireonlyone) + +## References + +### AtLeastOne + +Re-exports [AtLeastOne](utils/types.md#atleastonet-r) + +### CreateUrlOptions + +Re-exports [CreateUrlOptions](api/useNHTSA.md#createurloptions) + +### DecodeVinExtendedResults + +Re-exports [DecodeVinExtendedResults](api/endpoints/DecodeVinExtended.md#decodevinextendedresults) + +### DecodeVinExtendedVariable + +Re-exports [DecodeVinExtendedVariable](api/endpoints/DecodeVinExtended.md#decodevinextendedvariable) + +### DecodeVinResults + +Re-exports [DecodeVinResults](api/endpoints/DecodeVin.md#decodevinresults) + +### DecodeVinValuesBatchResults + +Re-exports [DecodeVinValuesBatchResults](api/endpoints/DecodeVinValuesBatch.md#decodevinvaluesbatchresults) + +### DecodeVinValuesExtendedResults + +Re-exports [DecodeVinValuesExtendedResults](api/endpoints/DecodeVinValuesExtended.md#decodevinvaluesextendedresults) + +### DecodeVinValuesResults + +Re-exports [DecodeVinValuesResults](api/endpoints/DecodeVinValues.md#decodevinvaluesresults) + +### DecodeVinVariable + +Re-exports [DecodeVinVariable](api/endpoints/DecodeVin.md#decodevinvariable) + +### DecodeWMIResults + +Re-exports [DecodeWMIResults](api/endpoints/DecodeWMI.md#decodewmiresults) + +### GetAllMakesResults + +Re-exports [GetAllMakesResults](api/endpoints/GetAllMakes.md#getallmakesresults) + +### GetAllManufacturersResults + +Re-exports [GetAllManufacturersResults](api/endpoints/GetAllManufacturers.md#getallmanufacturersresults) + +### GetCanadianVehicleSpecificationsResults + +Re-exports [GetCanadianVehicleSpecificationsResults](api/endpoints/GetCanadianVehicleSpecifications.md#getcanadianvehiclespecificationsresults) + +### GetEquipmentPlantCodesParams + +Re-exports [GetEquipmentPlantCodesParams](api/endpoints/GetEquipmentPlantCodes.md#getequipmentplantcodesparams) + +### GetEquipmentPlantCodesResults + +Re-exports [GetEquipmentPlantCodesResults](api/endpoints/GetEquipmentPlantCodes.md#getequipmentplantcodesresults) + +### GetMakeForManufacturerResults + +Re-exports [GetMakeForManufacturerResults](api/endpoints/GetMakeForManufacturer.md#getmakeformanufacturerresults) + +### GetMakesForManufacturerAndYearResults + +Re-exports [GetMakesForManufacturerAndYearResults](api/endpoints/GetMakesForManufacturerAndYear.md#getmakesformanufacturerandyearresults) + +### GetMakesForVehicleTypeResults + +Re-exports [GetMakesForVehicleTypeResults](api/endpoints/GetMakesForVehicleType.md#getmakesforvehicletyperesults) + +### GetManufacturerDetailsResults + +Re-exports [GetManufacturerDetailsResults](api/endpoints/GetManufacturerDetails.md#getmanufacturerdetailsresults) + +### GetModelsForMakeIdResults + +Re-exports [GetModelsForMakeIdResults](api/endpoints/GetModelsForMakeId.md#getmodelsformakeidresults) + +### GetModelsForMakeIdYearResults + +Re-exports [GetModelsForMakeIdYearResults](api/endpoints/GetModelsForMakeIdYear.md#getmodelsformakeidyearresults) + +### GetModelsForMakeResults + +Re-exports [GetModelsForMakeResults](api/endpoints/GetModelsForMake.md#getmodelsformakeresults) + +### GetModelsForMakeYearResults + +Re-exports [GetModelsForMakeYearResults](api/endpoints/GetModelsForMakeYear.md#getmodelsformakeyearresults) + +### GetPartsResults + +Re-exports [GetPartsResults](api/endpoints/GetParts.md#getpartsresults) + +### GetVehicleTypesForMakeIdResults + +Re-exports [GetVehicleTypesForMakeIdResults](api/endpoints/GetVehicleTypesForMakeId.md#getvehicletypesformakeidresults) + +### GetVehicleTypesForMakeResults + +Re-exports [GetVehicleTypesForMakeResults](api/endpoints/GetVehicleTypesForMake.md#getvehicletypesformakeresults) + +### GetVehicleVariableListResults + +Re-exports [GetVehicleVariableListResults](api/endpoints/GetVehicleVariableList.md#getvehiclevariablelistresults) + +### GetVehicleVariableValuesListResults + +Re-exports [GetVehicleVariableValuesListResults](api/endpoints/GetVehicleVariableValuesList.md#getvehiclevariablevalueslistresults) + +### GetWMIsForManufacturerResults + +Re-exports [GetWMIsForManufacturerResults](api/endpoints/GetWMIsForManufacturer.md#getwmisformanufacturerresults) + +### IArgToValidate + +Re-exports [IArgToValidate](utils/argHandler.md#iargtovalidate) + +### NhtsaResponse + +Re-exports [NhtsaResponse](api/types.md#nhtsaresponset) + +### QueryStringParams + +Re-exports [QueryStringParams](utils/queryString.md#querystringparams) + +### QueryStringParamsEncoded + +Re-exports [QueryStringParamsEncoded](utils/queryString.md#querystringparamsencodedt) + +### QueryStringTypes + +Re-exports [QueryStringTypes](utils/queryString.md#querystringtypes) + +### RequireOnlyOne + +Re-exports [RequireOnlyOne](utils/types.md#requireonlyonet-keys) diff --git a/apps/docs/src/typedoc/utils.md b/apps/docs/src/typedoc/utils.md new file mode 100644 index 00000000..97cdd1c1 --- /dev/null +++ b/apps/docs/src/typedoc/utils.md @@ -0,0 +1,58 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](modules.md) / utils + +# utils + +## Contents + +- [References](utils.md#references) + - [catchInvalidArguments](utils.md#catchinvalidarguments) + - [createQueryString](utils.md#createquerystring) + - [encodeQueryStringParams](utils.md#encodequerystringparams) + - [getTypeof](utils.md#gettypeof) + - [handleError](utils.md#handleerror) + - [isError](utils.md#iserror) + - [isValidVin](utils.md#isvalidvin) + - [rejectWithError](utils.md#rejectwitherror) + - [validateArgument](utils.md#validateargument) + +## References + +### catchInvalidArguments + +Re-exports [catchInvalidArguments](utils/argHandler.md#catchinvalidarguments) + +### createQueryString + +Re-exports [createQueryString](utils/queryString.md#createquerystring) + +### encodeQueryStringParams + +Re-exports [encodeQueryStringParams](utils/queryString.md#encodequerystringparams) + +### getTypeof + +Re-exports [getTypeof](utils/getTypeof.md#gettypeof) + +### handleError + +Re-exports [handleError](utils/errorHandler.md#handleerror) + +### isError + +Re-exports [isError](utils/errorHandler.md#iserror) + +### isValidVin + +Re-exports [isValidVin](utils/isValidVin.md#isvalidvin) + +### rejectWithError + +Re-exports [rejectWithError](utils/errorHandler.md#rejectwitherror) + +### validateArgument + +Re-exports [validateArgument](utils/argHandler.md#validateargument) diff --git a/apps/docs/src/typedoc/modules/utils_argHandler.md b/apps/docs/src/typedoc/utils/argHandler.md similarity index 57% rename from apps/docs/src/typedoc/modules/utils_argHandler.md rename to apps/docs/src/typedoc/utils/argHandler.md index 84529275..ee92d3de 100644 --- a/apps/docs/src/typedoc/modules/utils_argHandler.md +++ b/apps/docs/src/typedoc/utils/argHandler.md @@ -1,33 +1,44 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / utils/argHandler +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../index.md) \| API ) -# Module: utils/argHandler +*** -## Table of contents +[@shaggytools/nhtsa-api-wrapper](../modules.md) / utils/argHandler -### Type Aliases +# utils/argHandler -- [IArgToValidate](utils_argHandler.md#iargtovalidate) +## Contents -### Functions - -- [catchInvalidArguments](utils_argHandler.md#catchinvalidarguments) -- [validateArgument](utils_argHandler.md#validateargument) +- [Type Aliases](argHandler.md#type-aliases) + - [IArgToValidate](argHandler.md#iargtovalidate) +- [Functions](argHandler.md#functions) + - [catchInvalidArguments()](argHandler.md#catchinvalidarguments) + - [validateArgument()](argHandler.md#validateargument) + - [Options](argHandler.md#options) + - [Validation Logic](argHandler.md#validation-logic) ## Type Aliases ### IArgToValidate -Ƭ **IArgToValidate**: { `errorMode?`: `"error"` \| `"boolean"` ; `name`: `string` ; `value`: `unknown` } & [`AtLeastOne`](utils_types.md#atleastone)<{ `required?`: `boolean` ; `types?`: `string`[] }\> +> **IArgToValidate**: `object` & [`AtLeastOne`](types.md#atleastonet-r)\<`object`\> + +#### Type declaration -#### Defined in +| Member | Type | Description | +| :------ | :------ | :------ | +| `errorMode` | `"error"` \| `"boolean"` | - | +| `name` | `string` | - | +| `value` | `unknown` | - | + +#### Source [utils/argHandler.ts:9](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/utils/argHandler.ts#L9) ## Functions -### catchInvalidArguments +### catchInvalidArguments() -▸ **catchInvalidArguments**(`options`): `boolean` +> **catchInvalidArguments**(`options`): `boolean` Catches invalid arguments passed to functions and throws an error with a message detailing the invalid argument(s) and what was expected. @@ -42,11 +53,11 @@ validation logic works and how to override the default error throwing behavior. #### Parameters -| Name | Type | Description | -| :-------------- | :------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------- | -| `options` | `Object` | options object | -| `options.args` | [`IArgToValidate`](utils_argHandler.md#iargtovalidate)[] | array of IArgToValidate objects | -| `options.mode?` | `"default"` \| `"atLeast"` | 'default' or 'atLeast' - 'default' will validate all args, 'atLeast' will validate at least one arg in in the array has a defined value | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `options` | `object` | options object | +| `options.args` | [`IArgToValidate`](argHandler.md#iargtovalidate)[] | array of IArgToValidate objects | +| `options.mode`? | `"default"` \| `"atLeast"` | 'default' or 'atLeast' - 'default' will validate all
args, 'atLeast' will validate at least one arg in in the array has a defined value | #### Returns @@ -54,21 +65,20 @@ validation logic works and how to override the default error throwing behavior. - true if validation passes, throws error in the case of validation failure -#### Defined in +#### Source [utils/argHandler.ts:148](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/utils/argHandler.ts#L148) ---- +*** -### validateArgument +### validateArgument() -▸ **validateArgument**(`options`): `boolean` +> **validateArgument**(`options`): `boolean` Will validate a single argument based on the provided options and throws an error with a message detailing the invalid argument(s) and what was expected. There are two modes for this function: - - 'error' - (default) - Throws an error if the argument fails validation. - 'boolean' - Returns false if the argument fails validation, does not throw an error. @@ -93,8 +103,8 @@ In default mode, it uses the `options.name` and `options.types` array (if provid error message in the case of validation failure. - `options.name` and `options.value` are required in each arg object. It's ok to pass undefined - as the value, i.e. `{ value: someVarThatMightBeUndefined }`, but you must provide a name for the - argument. If you didn't provide a name then the error message would not be as helpful. +as the value, i.e. `{ value: someVarThatMightBeUndefined }`, but you must provide a name for the +argument. If you didn't provide a name then the error message would not be as helpful. - `options.required` and `options.types` are optional. @@ -111,27 +121,27 @@ that the typeof value is one of the provided strings in the `types` array. If `required` is true and no `types` are provided, it will only validate value is defined. - If `types` is provided but it is not `required`, it will only validate value is one of the - type strings in the `types` array. +type strings in the `types` array. - If `types` is provided but it is not `required` and value is 'undefined' it will skip - validation as there is no value to validate against and user would mark it required if they - wanted to validate against a defined value. If the value is not required and you give types of - ['string', 'number'] for example, it will validate that the value is either a string or a number. +validation as there is no value to validate against and user would mark it required if they +wanted to validate against a defined value. If the value is not required and you give types of +['string', 'number'] for example, it will validate that the value is either a string or a number. - If neither `required` nor `types` are provided, it will not peerform validation and will - simply return true. +simply return true. #### Parameters -| Name | Type | Description | -| :-------- | :----------------------------------------------------- | :------------- | -| `options` | [`IArgToValidate`](utils_argHandler.md#iargtovalidate) | options object | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `options` | [`IArgToValidate`](argHandler.md#iargtovalidate) | options object | #### Returns `boolean` - true if validation passes, mode 'error' throws Error in the case of - validation failure, mode 'boolean' returns false in the case of validation failure +validation failure, mode 'boolean' returns false in the case of validation failure -#### Defined in +#### Source [utils/argHandler.ts:83](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/utils/argHandler.ts#L83) diff --git a/apps/docs/src/typedoc/modules/utils_errorHandler.md b/apps/docs/src/typedoc/utils/errorHandler.md similarity index 53% rename from apps/docs/src/typedoc/modules/utils_errorHandler.md rename to apps/docs/src/typedoc/utils/errorHandler.md index 26ee55c0..8381af47 100644 --- a/apps/docs/src/typedoc/modules/utils_errorHandler.md +++ b/apps/docs/src/typedoc/utils/errorHandler.md @@ -1,20 +1,23 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / utils/errorHandler +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../index.md) \| API ) -# Module: utils/errorHandler +*** -## Table of contents +[@shaggytools/nhtsa-api-wrapper](../modules.md) / utils/errorHandler -### Functions +# utils/errorHandler -- [handleError](utils_errorHandler.md#handleerror) -- [isError](utils_errorHandler.md#iserror) -- [rejectWithError](utils_errorHandler.md#rejectwitherror) +## Contents + +- [Functions](errorHandler.md#functions) + - [handleError()](errorHandler.md#handleerror) + - [isError()](errorHandler.md#iserror) + - [rejectWithError()](errorHandler.md#rejectwitherror) ## Functions -### handleError +### handleError() -▸ **handleError**(`error`): `Error` +> **handleError**(`error`): `Error` Handles errors by returning an Error instance. Accepts any type of value but will return default error message of `an unknown error occurred` if @@ -22,8 +25,8 @@ Accepts any type of value but will return default error message of `an unknown e #### Parameters -| Name | Type | Description | -| :------ | :-------- | :---------------- | +| Parameter | Type | Description | +| :------ | :------ | :------ | | `error` | `unknown` | Any type of value | #### Returns @@ -32,22 +35,22 @@ Accepts any type of value but will return default error message of `an unknown e - instance of Error with message -#### Defined in +#### Source [utils/errorHandler.ts:26](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/utils/errorHandler.ts#L26) ---- +*** -### isError +### isError() -▸ **isError**(`error`): `boolean` +> **isError**(`error`): `boolean` Checks if `error` is an instance of any Error type. #### Parameters -| Name | Type | Description | -| :------ | :-------- | :---------------- | +| Parameter | Type | Description | +| :------ | :------ | :------ | | `error` | `unknown` | Any type of value | #### Returns @@ -56,30 +59,30 @@ Checks if `error` is an instance of any Error type. - True if `error` is an instance of Error, TypeError, etc. -#### Defined in +#### Source [utils/errorHandler.ts:14](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/utils/errorHandler.ts#L14) ---- +*** -### rejectWithError +### rejectWithError() -▸ **rejectWithError**(`error`): `Promise`<`never`\> +> **rejectWithError**(`error`): `Promise`\<`never`\> Returns a Promise rejection containing an Error instance. -Uses [handleError](utils_errorHandler.md#handleerror) to return a default error message if `error` is +Uses [handleError](errorHandler.md#handleerror) to return a default error message if `error` is not an Error type. #### Parameters -| Name | Type | Description | -| :------ | :-------- | :---------------- | +| Parameter | Type | Description | +| :------ | :------ | :------ | | `error` | `unknown` | Any type of value | #### Returns -`Promise`<`never`\> +`Promise`\<`never`\> -#### Defined in +#### Source [utils/errorHandler.ts:47](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/utils/errorHandler.ts#L47) diff --git a/apps/docs/src/typedoc/modules/utils_getTypeof.md b/apps/docs/src/typedoc/utils/getTypeof.md similarity index 61% rename from apps/docs/src/typedoc/modules/utils_getTypeof.md rename to apps/docs/src/typedoc/utils/getTypeof.md index d477a5c2..cd1a141e 100644 --- a/apps/docs/src/typedoc/modules/utils_getTypeof.md +++ b/apps/docs/src/typedoc/utils/getTypeof.md @@ -1,18 +1,21 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / utils/getTypeof +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../index.md) \| API ) -# Module: utils/getTypeof +*** -## Table of contents +[@shaggytools/nhtsa-api-wrapper](../modules.md) / utils/getTypeof -### Functions +# utils/getTypeof -- [getTypeof](utils_getTypeof.md#gettypeof) +## Contents + +- [Functions](getTypeof.md#functions) + - [getTypeof()](getTypeof.md#gettypeof) ## Functions -### getTypeof +### getTypeof() -▸ **getTypeof**(`value`): `string` +> **getTypeof**(`value`): `string` Gets type of `value` using `Object.prototype.toString.call(value)`. @@ -24,8 +27,8 @@ It will also accurately recognize any Error types, Error, TypeError, etc., as 'e #### Parameters -| Name | Type | Description | -| :------ | :-------- | :-------------------------------------------------------- | +| Parameter | Type | Description | +| :------ | :------ | :------ | | `value` | `unknown` | Any kind of value (string, object, array, function, etc). | #### Returns @@ -34,6 +37,6 @@ It will also accurately recognize any Error types, Error, TypeError, etc., as 'e - Type of value, normalized to a lowercase string. -#### Defined in +#### Source [utils/getTypeof.ts:18](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/utils/getTypeof.ts#L18) diff --git a/apps/docs/src/typedoc/modules/utils_isValidVin.md b/apps/docs/src/typedoc/utils/isValidVin.md similarity index 60% rename from apps/docs/src/typedoc/modules/utils_isValidVin.md rename to apps/docs/src/typedoc/utils/isValidVin.md index 1e2b1200..8cf846cc 100644 --- a/apps/docs/src/typedoc/modules/utils_isValidVin.md +++ b/apps/docs/src/typedoc/utils/isValidVin.md @@ -1,29 +1,32 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / utils/isValidVin +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../index.md) \| API ) -# Module: utils/isValidVin +*** -## Table of contents +[@shaggytools/nhtsa-api-wrapper](../modules.md) / utils/isValidVin -### Functions +# utils/isValidVin -- [isValidVin](utils_isValidVin.md#isvalidvin) +## Contents + +- [Functions](isValidVin.md#functions) + - [isValidVin()](isValidVin.md#isvalidvin) ## Functions -### isValidVin +### isValidVin() -▸ **isValidVin**(`vin`): `boolean` +> **isValidVin**(`vin`): `boolean` Provides **offline** validation of Vehicle Identification Numbers (VINs) using the -[VIN Check Algorithm](). +[VIN Check Algorithm](https://en.wikibooks.org/wiki/Vehicle_Identification_Numbers_(VIN_codes)/Check_digit). If you need to test that the algorithm is working correctly, you can use 17 ones `1` as the VIN and it should return `true` as the result. #### Parameters -| Name | Type | Description | -| :---- | :------- | :----------------------------- | +| Parameter | Type | Description | +| :------ | :------ | :------ | | `vin` | `string` | Vehicle Identification Number. | #### Returns @@ -32,25 +35,23 @@ the VIN and it should return `true` as the result. True for a valid VIN, false for an invalid VIN. -**`Example`** +#### Example Browser via html script tags - ```ts const isValid = NHTSA.isValidVin('3VWD07AJ5EM388202') console.log(isValid) // true ``` -**`Example`** +#### Example Imported as a module - ```ts import { isValidVin } from '@shaggytools/nhtsa-api-wrapper' const isValid = isValidVin('3VWD07AJ5EM388202') console.log(isValid) // true ``` -#### Defined in +#### Source [utils/isValidVin.ts:66](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/utils/isValidVin.ts#L66) diff --git a/apps/docs/src/typedoc/modules/utils_queryString.md b/apps/docs/src/typedoc/utils/queryString.md similarity index 56% rename from apps/docs/src/typedoc/modules/utils_queryString.md rename to apps/docs/src/typedoc/utils/queryString.md index 4c3d7ec6..7191aae3 100644 --- a/apps/docs/src/typedoc/modules/utils_queryString.md +++ b/apps/docs/src/typedoc/utils/queryString.md @@ -1,67 +1,68 @@ -[@shaggytools/nhtsa-api-wrapper - v3.0.4](../index.md) / [Exports](../modules.md) / utils/queryString +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../index.md) \| API ) -# Module: utils/queryString +*** -## Table of contents +[@shaggytools/nhtsa-api-wrapper](../modules.md) / utils/queryString -### Type Aliases +# utils/queryString -- [QueryStringParams](utils_queryString.md#querystringparams) -- [QueryStringParamsEncoded](utils_queryString.md#querystringparamsencoded) -- [QueryStringTypes](utils_queryString.md#querystringtypes) +## Contents -### Functions - -- [createQueryString](utils_queryString.md#createquerystring) -- [encodeQueryStringParams](utils_queryString.md#encodequerystringparams) +- [Type Aliases](queryString.md#type-aliases) + - [QueryStringParams](queryString.md#querystringparams) + - [QueryStringParamsEncoded``](queryString.md#querystringparamsencodedt) + - [QueryStringTypes](queryString.md#querystringtypes) +- [Functions](queryString.md#functions) + - [createQueryString()](queryString.md#createquerystring) + - [encodeQueryStringParams()](queryString.md#encodequerystringparams) ## Type Aliases ### QueryStringParams -Ƭ **QueryStringParams**: `Record`<`string`, [`QueryStringTypes`](utils_queryString.md#querystringtypes)\> +> **QueryStringParams**: `Record`\<`string`, [`QueryStringTypes`](queryString.md#querystringtypes)\> Object to build the query string with -#### Defined in +#### Source [utils/queryString.ts:13](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/utils/queryString.ts#L13) ---- +*** -### QueryStringParamsEncoded +### QueryStringParamsEncoded`` -Ƭ **QueryStringParamsEncoded**<`T`\>: { [key in keyof T]: string } +> **QueryStringParamsEncoded**\<`T`\>: `{ [key in keyof T]: string }` Object returned by encodeQueryStringParams() #### Type parameters -| Name | -| :--- | -| `T` | +| Parameter | +| :------ | +| `T` | -#### Defined in +#### Source [utils/queryString.ts:16](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/utils/queryString.ts#L16) ---- +*** ### QueryStringTypes -Ƭ **QueryStringTypes**: `string` \| `number` \| `boolean` +> **QueryStringTypes**: `string` \| `number` \| `boolean` Valid URI component types -#### Defined in +#### Source [utils/queryString.ts:10](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/utils/queryString.ts#L10) ## Functions -### createQueryString +### createQueryString() -▸ **createQueryString**<`T`\>(`params?`, `allowEmptyParams?`): `string` +> **createQueryString**\<`T`\>(`params`, `allowEmptyParams`?): `string` This function is used internally by other package functions. As a consumer of this package, you should not need to use this function directly in most cases. @@ -85,16 +86,16 @@ formats at this time. This means the default query string will be `"?format=json #### Type parameters -| Name | Type | -| :--- | :-------------------------------------------------------------------- | -| `T` | extends [`QueryStringParams`](utils_queryString.md#querystringparams) | +| Parameter | +| :------ | +| `T` extends [`QueryStringParams`](queryString.md#querystringparams) | #### Parameters -| Name | Type | Default value | Description | -| :------------------ | :-------- | :------------ | :------------------------------------------------------------------------ | -| `params` | `T` | `undefined` | An object of search parameters to be converted to a query string. | -| `allowEmptyParams?` | `boolean` | `false` | Set to `true` to include keys with empty string values, e.g. 'emptyKey='. | +| Parameter | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `params` | `T` | `undefined` | An object of search parameters to be converted to a query
string. | +| `allowEmptyParams`? | `boolean` | `false` | Set to `true` to include keys with empty string
values, e.g. 'emptyKey='. | #### Returns @@ -102,15 +103,15 @@ formats at this time. This means the default query string will be `"?format=json - A query string of search parameters for use in a final fetch URL. -#### Defined in +#### Source [utils/queryString.ts:100](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/utils/queryString.ts#L100) ---- +*** -### encodeQueryStringParams +### encodeQueryStringParams() -▸ **encodeQueryStringParams**<`T`\>(`params`): [`QueryStringParamsEncoded`](utils_queryString.md#querystringparamsencoded)<`T`\> +> **encodeQueryStringParams**\<`T`\>(`params`): [`QueryStringParamsEncoded`](queryString.md#querystringparamsencodedt)\<`T`\> This function is used internally by other package functions. As a consumer of this package, you should not need to use this function directly in most cases. @@ -134,24 +135,24 @@ functions. However, it _is_ exported by the package as part of the composable fu #### Type parameters -| Name | Type | -| :--- | :-------------------------------------------------------------------- | -| `T` | extends [`QueryStringParams`](utils_queryString.md#querystringparams) | +| Parameter | +| :------ | +| `T` extends [`QueryStringParams`](queryString.md#querystringparams) | #### Parameters -| Name | Type | Description | -| :------- | :--- | :-------------------------------------------- | -| `params` | `T` | An object of search parameters to be encoded. | +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `params` | `T` | An object of search parameters to be encoded. | #### Returns -[`QueryStringParamsEncoded`](utils_queryString.md#querystringparamsencoded)<`T`\> +[`QueryStringParamsEncoded`](queryString.md#querystringparamsencodedt)\<`T`\> - A new object of same keys as the original object with - values converted to URI component strings. Any keys with values not a string, number, or - boolean are filtered out of final object. +values converted to URI component strings. Any keys with values not a string, number, or +boolean are filtered out of final object. -#### Defined in +#### Source [utils/queryString.ts:44](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/utils/queryString.ts#L44) diff --git a/apps/docs/src/typedoc/utils/types.md b/apps/docs/src/typedoc/utils/types.md new file mode 100644 index 00000000..27caf991 --- /dev/null +++ b/apps/docs/src/typedoc/utils/types.md @@ -0,0 +1,76 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](../index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](../modules.md) / utils/types + +# utils/types + +## Contents + +- [References](types.md#references) + - [IArgToValidate](types.md#iargtovalidate) + - [QueryStringParams](types.md#querystringparams) + - [QueryStringParamsEncoded](types.md#querystringparamsencoded) + - [QueryStringTypes](types.md#querystringtypes) +- [Type Aliases](types.md#type-aliases) + - [AtLeastOne``](types.md#atleastonet-r) + - [RequireOnlyOne``](types.md#requireonlyonet-keys) + +## References + +### IArgToValidate + +Re-exports [IArgToValidate](argHandler.md#iargtovalidate) + +### QueryStringParams + +Re-exports [QueryStringParams](queryString.md#querystringparams) + +### QueryStringParamsEncoded + +Re-exports [QueryStringParamsEncoded](queryString.md#querystringparamsencodedt) + +### QueryStringTypes + +Re-exports [QueryStringTypes](queryString.md#querystringtypes) + +## Type Aliases + +### AtLeastOne`` + +> **AtLeastOne**\<`T`, `R`\>: `{ [P in R]-?: Required> & Partial> }`\[`R`\] + +Require at least one of a set of properties in an object +https://stackoverflow.com/a/49725198 + +#### Type parameters + +| Parameter | Default | +| :------ | :------ | +| `T` | - | +| `R` extends keyof `T` | keyof `T` | + +#### Source + +[utils/types.ts:18](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/utils/types.ts#L18) + +*** + +### RequireOnlyOne`` + +> **RequireOnlyOne**\<`T`, `Keys`\>: `Omit`\<`T`, `Keys`\> & `{ [K in keyof Required]: Required> & Partial, undefined>> }`\[`Keys`\] + +Require only one of a set of properties in an object +https://stackoverflow.com/a/49725198 + +#### Type parameters + +| Parameter | Default | +| :------ | :------ | +| `T` | - | +| `Keys` extends keyof `T` | keyof `T` | + +#### Source + +[utils/types.ts:26](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/utils/types.ts#L26) diff --git a/apps/docs/src/typedoc/vite-env.md b/apps/docs/src/typedoc/vite-env.md new file mode 100644 index 00000000..615c4ed2 --- /dev/null +++ b/apps/docs/src/typedoc/vite-env.md @@ -0,0 +1,7 @@ +**@shaggytools/nhtsa-api-wrapper - v3.0.4** ( [Readme](index.md) \| API ) + +*** + +[@shaggytools/nhtsa-api-wrapper](modules.md) / vite-env + +# vite-env diff --git a/apps/docs/src/utils/use-nhtsa.md b/apps/docs/src/utils/use-nhtsa.md index 95f9af1e..7942c9a0 100644 --- a/apps/docs/src/utils/use-nhtsa.md +++ b/apps/docs/src/utils/use-nhtsa.md @@ -47,7 +47,7 @@ It also contains functions for building and returning the URL string for the VPI ::: tip See Also: -- [useNHTSA Reference](../typedoc/modules/api_useNHTSA) +- [useNHTSA Reference](../typedoc/api/useNHTSA) - [Alternate Use of This Package](../guide/bring-your-own-fetch#option-2-using-usenhtsa) @@ -159,7 +159,7 @@ get() ## Options -[`CreateUrlOptions`](../typedoc/modules/api_useNHTSA#createurloptions): +[`CreateUrlOptions`](../typedoc/api/useNHTSA#createurloptions): - `endpointName` - The name of the endpoint to use, see [VPIC API Endpoints](../api/#vpic-api-endpoints) (required) diff --git a/config/typedoc-config/package.json b/config/typedoc-config/package.json index 29bf4198..c54968b8 100644 --- a/config/typedoc-config/package.json +++ b/config/typedoc-config/package.json @@ -6,7 +6,7 @@ "main": "typedoc-config.js", "devDependencies": { "typedoc": "0.25.2", - "typedoc-plugin-markdown": "3.16.0", + "typedoc-plugin-markdown": "4.0.0-next.25", "typescript": "5.2.2" } } diff --git a/packages/lib/.typedoc/typedoc.cjs b/packages/lib/.typedoc/typedoc.cjs index 964f0a57..116abfb4 100644 --- a/packages/lib/.typedoc/typedoc.cjs +++ b/packages/lib/.typedoc/typedoc.cjs @@ -12,6 +12,12 @@ module.exports = { extends: 'typedoc-config', out, // typedoc-plugin-markdown options - entryDocument: './index.md', + entryFileName: 'index.md', readme: './README.md', + outputFileStrategy: 'modules', + parametersFormat: 'table', + propertiesFormat: 'table', + enumMembersFormat: 'table', + typeDeclarationFormat: 'table', + indexFormat: 'table', } diff --git a/packages/lib/package.json b/packages/lib/package.json index 9defbef7..a020912d 100644 --- a/packages/lib/package.json +++ b/packages/lib/package.json @@ -61,7 +61,7 @@ }, "scripts": { "preinstall": "npx only-allow pnpm", - "build": "pnpm run \"/^build:.*/\" && pnpm run format:typedoc", + "build": "pnpm run \"/^build:.*/\"", "build:lib": "tsc --noEmit && vite build", "build:typedocs": "typedoc --options .typedoc/typedoc.cjs", "dev": "pnpm run \"/^dev:.*/\"", @@ -70,7 +70,7 @@ "preview": "vite preview", "lint": "eslint .", "lint:fix": "eslint --fix", - "format": "prettier --write \"src/**/*.{ts,tsx,md}\"", + "format": "prettier --write \"src/**/*.{js,ts,md}\"", "format:typedoc": "pnpm --filter docs run format:typedoc", "test": "vitest", "coverage": "vitest --coverage", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index e2229512..f87ef9de 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -131,8 +131,8 @@ importers: specifier: 0.25.2 version: 0.25.2(typescript@5.2.2) typedoc-plugin-markdown: - specifier: 3.16.0 - version: 3.16.0(typedoc@0.25.2) + specifier: 4.0.0-next.25 + version: 4.0.0-next.25(typedoc@0.25.2) typescript: specifier: 5.2.2 version: 5.2.2 @@ -4407,19 +4407,6 @@ packages: /graphemer@1.4.0: resolution: {integrity: sha512-EtKwoO6kxCL9WO5xipiHTZlSzBm7WLT627TqC/uVRd0HKmq8NXyebnNYxDoBi7wt8eTWrUrKXCOVaFq9x1kgag==} - /handlebars@4.7.7: - resolution: {integrity: sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==} - engines: {node: '>=0.4.7'} - hasBin: true - dependencies: - minimist: 1.2.8 - neo-async: 2.6.2 - source-map: 0.6.1 - wordwrap: 1.0.0 - optionalDependencies: - uglify-js: 3.17.4 - dev: true - /hard-rejection@2.1.0: resolution: {integrity: sha512-VIZB+ibDhx7ObhAe7OVtoEbuP4h/MuOTHJ+J8h/eBXotJYl0fBgR72xDFCKgIh22OJZIOVNxBMWuhAr10r8HdA==} engines: {node: '>=6'} @@ -5323,10 +5310,6 @@ packages: /natural-compare@1.4.0: resolution: {integrity: sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==} - /neo-async@2.6.2: - resolution: {integrity: sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==} - dev: true - /node-fetch@2.6.7: resolution: {integrity: sha512-ZjMPFEfVx5j+y2yF35Kzx5sF7kDzxuDj6ziH4FFbOp87zKDZNx8yExJIb05OGF4Nlt9IHFIMBkRl41VdvcNdbQ==} engines: {node: 4.x || >=6.0.0} @@ -6580,12 +6563,11 @@ packages: is-typed-array: 1.1.10 dev: true - /typedoc-plugin-markdown@3.16.0(typedoc@0.25.2): - resolution: {integrity: sha512-eeiC78fDNGFwemPIHiwRC+mEC7W5jwt3fceUev2gJ2nFnXpVHo8eRrpC9BLWZDee6ehnz/sPmNjizbXwpfaTBw==} + /typedoc-plugin-markdown@4.0.0-next.25(typedoc@0.25.2): + resolution: {integrity: sha512-OAucyztjyTcJhpyH8lK3r6W/9lGYxRnEphmphAi8CLL4pBqzA9A00OaOWt4ybkcFBnB8zNIZ4SGCz1sk9NBA3g==} peerDependencies: - typedoc: '>=0.24.0' + typedoc: '>=0.25.0' dependencies: - handlebars: 4.7.7 typedoc: 0.25.2(typescript@5.2.2) dev: true @@ -6618,14 +6600,6 @@ packages: resolution: {integrity: sha512-uY/99gMLIOlJPwATcMVYfqDSxUR9//AUcgZMzwfSTJPDKzA1S8mX4VLqa+fiAtveraQUBCz4FFcwVZBGbwBXIw==} dev: true - /uglify-js@3.17.4: - resolution: {integrity: sha512-T9q82TJI9e/C1TAxYvfb16xO120tMVFZrGA3f9/P4424DNu6ypK103y0GPFVa17yotwSyZW5iYXgjYHkGrJW/g==} - engines: {node: '>=0.8.0'} - hasBin: true - requiresBuild: true - dev: true - optional: true - /unbox-primitive@1.0.2: resolution: {integrity: sha512-61pPlCD9h51VoreyJ0BReideM3MDKMKnh6+V9L08331ipq6Q8OFXZYiqP6n/tbHx4s5I9uRhcye6BrbkizkBDw==} dependencies: @@ -7131,10 +7105,6 @@ packages: stackback: 0.0.2 dev: true - /wordwrap@1.0.0: - resolution: {integrity: sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q==} - dev: true - /workbox-background-sync@7.0.0: resolution: {integrity: sha512-S+m1+84gjdueM+jIKZ+I0Lx0BDHkk5Nu6a3kTVxP4fdj3gKouRNmhO8H290ybnJTOPfBDtTMXSQA/QLTvr7PeA==} dependencies: