Class VantAPI

app

closed

Readonly keys

log

Optional server

settings

close

• close(): Promise<void>

• Stops the http server and closes the connection to the database. This action is final!

  Returns Promise<void>

configure

• configure(settings): Promise<void>

• Configures the vant api. You can setup the default units, the used port and the logging behaviour. Pass { useEnvironmentVariables: true } to setup these settings using environment variables (e.g. stored in a .env file).

  Parameters

  • settings: MinimumAPISettings

  Returns Promise<void>

generateAPIKey

• generateAPIKey(role): Promise<string>

• Generates a new api key for your api with the passed role. Once the key has been stored in the database the promise resolves and the uuidv4 key is returned as string.

  Role explanations

  • "read": One can use read routes only (requesting any kind of weather data)
  • "write": One can use write routes only (uploading new weather data using post requests)
  • "readwrite": Once can use all write and read routes.
  • "admin": One can use all write / read routes and generate new api keys.

  Parameters

  • role: APIUserRole

    your desired role

  Returns Promise<string>

  the uuidv4 api key as string

startServer

• startServer(): Promise<void>

• Starts the http server on the configured port. The promise resolves when the server starts listening for incoming requests.

  Returns Promise<void>

stopServer

• stopServer(): Promise<void>

• Stops the http server. If the server hasn't been started yet no error will occur (but a warning will be logged).

  Returns Promise<void>