From 0eb7ccc4febb34206f808cba6fe18794fb7717d2 Mon Sep 17 00:00:00 2001 From: Teppo Kurki Date: Mon, 19 Feb 2024 20:14:39 +0200 Subject: [PATCH] doc: tweak config field descriptions, default url Try to improve the concise descriptions of the configuration fields and add a default http://127.0.0.1:8086 value for url. --- src/influx.ts | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/influx.ts b/src/influx.ts index 86c7555..e700802 100644 --- a/src/influx.ts +++ b/src/influx.ts @@ -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 /** @@ -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 @@ -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 */