@shaggytools/nhtsa-api-wrapper - v3.0.4 / Exports / api/useNHTSA

Module: api/useNHTSA ​

Table of contents ​

Type Aliases ​

• CreateUrlOptions

Functions ​

• useNHTSA

Type Aliases ​

CreateUrlOptions ​

Ƭ CreateUrlOptions: Object

Type declaration ​

Defined in ​

api/useNHTSA.ts:15

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

Defined in ​

api/useNHTSA.ts:50