Skip to content

Commit

Permalink
doc: tweak config field descriptions, default url
Browse files Browse the repository at this point in the history
Try to improve the concise descriptions of the
configuration fields and add a default http://127.0.0.1:8086
value for url.
  • Loading branch information
tkurki committed Feb 19, 2024
1 parent c77250e commit 0eb7ccc
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions src/influx.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,9 @@ export const SELF_TAG_VALUE = 'true'
export interface SKInfluxConfig {
/**
* Url of the InfluxDb 2 server
*
* @default http://127.0.0.1:8086
* @title Url
* @description InfluxDB server address in http://hostname:port format
*/
url: string
/**
Expand All @@ -50,7 +51,7 @@ export interface SKInfluxConfig {
/**
* @title Store only self data
* @default true
* @description Store data only for "self" data, not for example AIS targets' data
* @description Store data only for "self" vessel, not for example AIS targets' data
*/
onlySelf: boolean

Expand All @@ -69,7 +70,7 @@ export interface SKInfluxConfig {
ignoredSources: string[]

/**
* @title Use timestamps in SK data
* @title Use timestamps from SK data
* @default false
* @description Whether the timestamps in SK data should be used instead of time of insertion to InfluxDB
*/
Expand Down

0 comments on commit 0eb7ccc

Please sign in to comment.