Skip to content

Commit

Permalink
chore(docs): commit latest typedoc output after dep updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ShaggyTech committed Oct 27, 2023
1 parent ca86ea7 commit 56f346c
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 30 deletions.
24 changes: 6 additions & 18 deletions apps/docs/src/typedoc/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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)
24 changes: 12 additions & 12 deletions apps/docs/src/typedoc/modules/utils_isValidVin.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)

0 comments on commit 56f346c

Please sign in to comment.