From 56f346c979a324c0fe16ca6ea48c87367ee543c1 Mon Sep 17 00:00:00 2001 From: shaggytech Date: Fri, 27 Oct 2023 00:34:43 -0500 Subject: [PATCH] chore(docs): commit latest typedoc output after dep updates --- apps/docs/src/typedoc/modules.md | 24 +++++-------------- .../src/typedoc/modules/utils_isValidVin.md | 24 +++++++++---------- 2 files changed, 18 insertions(+), 30 deletions(-) diff --git a/apps/docs/src/typedoc/modules.md b/apps/docs/src/typedoc/modules.md index a80f47e92..1eed68bdd 100644 --- a/apps/docs/src/typedoc/modules.md +++ b/apps/docs/src/typedoc/modules.md @@ -4,13 +4,9 @@ ## Table of contents -### API Modules +### Modules - [api](modules/api.md) -- [api/useNHTSA](modules/api_useNHTSA.md) - -### API Endpoints Modules - - [api/endpoints](modules/api_endpoints.md) - [api/endpoints/DecodeVin](modules/api_endpoints_DecodeVin.md) - [api/endpoints/DecodeVinExtended](modules/api_endpoints_DecodeVinExtended.md) @@ -36,26 +32,18 @@ - [api/endpoints/GetVehicleVariableList](modules/api_endpoints_GetVehicleVariableList.md) - [api/endpoints/GetVehicleVariableValuesList](modules/api_endpoints_GetVehicleVariableValuesList.md) - [api/endpoints/GetWMIsForManufacturer](modules/api_endpoints_GetWMIsForManufacturer.md) - -### Other Modules - +- [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) -- [vite-env](modules/vite_env.md) - -### Types Modules - -- [api/endpoints/types](modules/api_endpoints_types.md) -- [api/types](modules/api_types.md) - [types](modules/types.md) -- [utils/types](modules/utils_types.md) - -### Utility Functions Modules - - [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) diff --git a/apps/docs/src/typedoc/modules/utils_isValidVin.md b/apps/docs/src/typedoc/modules/utils_isValidVin.md index 755a09c7f..1e2b1200c 100644 --- a/apps/docs/src/typedoc/modules/utils_isValidVin.md +++ b/apps/docs/src/typedoc/modules/utils_isValidVin.md @@ -20,6 +20,18 @@ Provides **offline** validation of Vehicle Identification Numbers (VINs) using t 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 | +| :---- | :------- | :----------------------------- | +| `vin` | `string` | Vehicle Identification Number. | + +#### Returns + +`boolean` + +True for a valid VIN, false for an invalid VIN. + **`Example`** Browser via html script tags @@ -39,18 +51,6 @@ const isValid = isValidVin('3VWD07AJ5EM388202') console.log(isValid) // true ``` -#### Parameters - -| Name | Type | Description | -| :---- | :------- | :----------------------------- | -| `vin` | `string` | Vehicle Identification Number. | - -#### Returns - -`boolean` - -True for a valid VIN, false for an invalid VIN. - #### Defined in [utils/isValidVin.ts:66](https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/src/utils/isValidVin.ts#L66)