Class KV<T>

Allow adding of a simple key/value pair to a log. When multiple key is detected, the first key logged prevails over subsequent value assigned to the same key

Type Parameters

T extends TLoggableValue

Hierarchy

AbstractKeyValue<T>
- KV

Index

Constructors

Properties

Accessors

Methods

toIJson toJSON merge mergeValue of

Constructors

constructor

new KV<T>(key: string, value: T): KV<T>
Type Parameters
- T extends TLoggableValue
Parameters
- key: string
- value: T
Returns KV<T>
Overrides AbstractKeyValue.constructor
- Defined in models.ts:222

Properties

`Protected` _key

_key: string

`Protected` _value

_value: T

Accessors

key

get key(): string
Returns string
Overrides AbstractKeyValue.key
- Defined in models.ts:228

value

get value(): T | T[]
Returns T | T[]
Overrides AbstractKeyValue.value
- Defined in models.ts:232

Methods

toIJson

toIJson(): IJson
Convert KV into a JSON

Returns

Returns IJson
Overrides AbstractKeyValue.toIJson
- Defined in models.ts:241

toJSON

toJSON(): IJson
Returns IJson
Inherited from AbstractKeyValue.toJSON
- Defined in core.ts:124

`Static` merge

merge<T>(...kvs: AbstractKeyValue<T>[]): IJson
Merge list of KVs and skip duplicate key if found later in the list

Returns
Type Parameters
- T extends TLoggableValue
Parameters
- Rest ...kvs: AbstractKeyValue<T>[]
Returns IJson
- Defined in models.ts:204

`Static` mergeValue

mergeValue<T>(...kvs: AbstractKeyValue<T>[]): IJson
Merge list of KVs if duplicate keys found, convert the value into an array.

N.B.: Use this method with caution as downstream system such as logstash does not like when datatype of a key changes. It could result in the log being missed.

Returns
Type Parameters
- T extends TLoggableValue
Parameters
- Rest ...kvs: AbstractKeyValue<T>[]
Returns IJson
- Defined in models.ts:218

`Static` of

of<T>(key: string, value: T): KV<T>
Factory method for KV

Returns
Type Parameters
- T extends TLoggableValue
Parameters
- key: string
- value: T
Returns KV<T>
- Defined in models.ts:194

Generated using TypeDoc