@gtsc/logging-models - npm Package Compare versions

Comparing version 0.0.3-next.12 to 0.0.3-next.13

dist/types/connectors/multiLoggingConnector.d.ts

@@ -20,9 +20,10 @@ import type { EntityCondition, SortDirection } from "@gtsc/entity";
      * Create a new instance of MultiLoggingConnector.
-     * @param dependencies The dependencies for the logging connector.
-     * @param dependencies.loggingConnectors The logging connectors to aggregate.
-     * @param config The configuration for the logging connector.
+     * @param options The options for the connector.
+     * @param options.loggingConnectorTypes The logging connectors to multiplex.
+     * @param options.config The configuration for the logging connector.
      */
-    constructor(dependencies: {
-        loggingConnectors: ILoggingConnector[];
-    }, config?: ILoggingLevelsConfig | undefined);
+    constructor(options: {
+        loggingConnectorTypes: string[];
+        config?: ILoggingLevelsConfig | undefined;
+    });
     /**
@@ -29,0 +30,0 @@ * Log an entry to the connector.

docs/overview.md

@@ -21,3 +21,3 @@ [**@gtsc/logging-models**](logging-models/overview.md) • **Docs**
 
-Detailed reference documentation for the API can be found in [docs/reference/modules.md](docs/reference/modules.md)
+Detailed reference documentation for the API can be found in [docs/reference/globals.md](docs/reference/globals.md)
 
@@ -24,0 +24,0 @@ ## Changelog

docs/reference/classes/MultiLoggingConnector.md

@@ -17,3 +17,3 @@ [**@gtsc/logging-models**](../overview.md) • **Docs**
 
-> **new MultiLoggingConnector**(`dependencies`, `config`?): [`MultiLoggingConnector`](MultiLoggingConnector.md)
+> **new MultiLoggingConnector**(`options`): [`MultiLoggingConnector`](MultiLoggingConnector.md)
 
@@ -24,11 +24,11 @@ Create a new instance of MultiLoggingConnector.
 
-• **dependencies**
+• **options**
 
-The dependencies for the logging connector.
+The options for the connector.
 
-• **dependencies.loggingConnectors**: [`ILoggingConnector`](../interfaces/ILoggingConnector.md)[]
+• **options.loggingConnectorTypes**: `string`[]
 
-The logging connectors to aggregate.
+The logging connectors to multiplex.
 
-• **config?**: [`ILoggingLevelsConfig`](../interfaces/ILoggingLevelsConfig.md)
+• **options.config?**: [`ILoggingLevelsConfig`](../interfaces/ILoggingLevelsConfig.md)
 
@@ -43,15 +43,15 @@ The configuration for the logging connector.
 
-### \_levels
+### \_loggingConnectors
 
-> `private` `readonly` **\_levels**: [`LogLevel`](../type-aliases/LogLevel.md)[]
+> `private` `readonly` **\_loggingConnectors**: [`ILoggingConnector`](../interfaces/ILoggingConnector.md)[]
 
-The log levels to display, will default to all.
+The connectors to send the log entries to.
 
 ***
 
-### \_loggingConnectors
+### \_levels
 
-> `private` `readonly` **\_loggingConnectors**: [`ILoggingConnector`](../interfaces/ILoggingConnector.md)[]
+> `private` `readonly` **\_levels**: [`LogLevel`](../type-aliases/LogLevel.md)[]
 
-The connectors to send the log entries to.
+The log levels to display, will default to all.
 
@@ -127,2 +127,8 @@ ## Methods
 
+##### entities
+
+> **entities**: `Partial`\<[`ILogEntry`](../interfaces/ILogEntry.md)\>[]
+
+The entities, which can be partial if a limited keys list was provided.
+
 ##### cursor?
@@ -134,8 +140,2 @@
 
-##### entities
-
-> **entities**: `Partial`\<[`ILogEntry`](../interfaces/ILogEntry.md)\>[]
-
-The entities, which can be partial if a limited keys list was provided.
-
 ##### pageSize?
@@ -142,0 +142,0 @@

docs/reference/classes/SilentLoggingConnector.md

@@ -92,2 +92,8 @@ [**@gtsc/logging-models**](../overview.md) • **Docs**
 
+##### entities
+
+> **entities**: `Partial`\<[`ILogEntry`](../interfaces/ILogEntry.md)\>[]
+
+The entities, which can be partial if a limited keys list was provided.
+
 ##### cursor?
@@ -99,8 +105,2 @@
 
-##### entities
-
-> **entities**: `Partial`\<[`ILogEntry`](../interfaces/ILogEntry.md)\>[]
-
-The entities, which can be partial if a limited keys list was provided.
-
 ##### pageSize?
@@ -107,0 +107,0 @@

docs/reference/globals.md

@@ -13,4 +13,4 @@ # @gtsc/logging-models
 - [ILoggingConnector](interfaces/ILoggingConnector.md)
+- [ILoggingLevelsConfig](interfaces/ILoggingLevelsConfig.md)
 - [ILoggingCreateRequest](interfaces/ILoggingCreateRequest.md)
-- [ILoggingLevelsConfig](interfaces/ILoggingLevelsConfig.md)
 - [ILoggingListRequest](interfaces/ILoggingListRequest.md)
@@ -17,0 +17,0 @@ - [ILoggingListResponse](interfaces/ILoggingListResponse.md)

docs/reference/interfaces/ILogEntry.md

@@ -11,23 +11,23 @@ [**@gtsc/logging-models**](../overview.md) • **Docs**
 
-### data?
+### level
 
-> `optional` **data**: `unknown`
+> **level**: [`LogLevel`](../type-aliases/LogLevel.md)
 
-Optional data for the message.
+The level of the error being logged.
 
 ***
 
-### error?
+### source
 
-> `optional` **error**: `IError`
+> **source**: `string`
 
-Optional error details.
+The source of the log entry.
 
 ***
 
-### level
+### ts?
 
-> **level**: [`LogLevel`](../type-aliases/LogLevel.md)
+> `optional` **ts**: `number`
 
-The level of the error being logged.
+The timestamp of the log entry, if left blank will be populated by the connector.
 
@@ -44,14 +44,14 @@ ***
 
-### source
+### error?
 
-> **source**: `string`
+> `optional` **error**: `IError`
 
-The source of the log entry.
+Optional error details.
 
 ***
 
-### ts?
+### data?
 
-> `optional` **ts**: `number`
+> `optional` **data**: `unknown`
 
-The timestamp of the log entry, if left blank will be populated by the connector.
+Optional data for the message.

docs/reference/interfaces/ILogging.md

@@ -39,2 +39,38 @@ [**@gtsc/logging-models**](../overview.md) • **Docs**
 
+### start()?
+
+> `optional` **start**(): `Promise`\<`void`\>
+
+The service needs to be started when the application is initialized.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Inherited from
+
+`IService.start`
+
+***
+
+### stop()?
+
+> `optional` **stop**(): `Promise`\<`void`\>
+
+The service needs to be stopped when the application is closed.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Inherited from
+
+`IService.stop`
+
+***
+
 ### log()
@@ -107,2 +143,8 @@
 
+##### entities
+
+> **entities**: [`ILogEntry`](ILogEntry.md)[]
+
+The entities, which can be partial if a limited keys list was provided.
+
 ##### cursor?
@@ -114,8 +156,2 @@
 
-##### entities
-
-> **entities**: [`ILogEntry`](ILogEntry.md)[]
-
-The entities, which can be partial if a limited keys list was provided.
-
 ##### pageSize?
@@ -136,37 +172,1 @@
 NotImplementedError if the implementation does not support retrieval.
-
-***
-
-### start()?
-
-> `optional` **start**(): `Promise`\<`void`\>
-
-The service needs to be started when the application is initialized.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-Nothing.
-
-#### Inherited from
-
-`IService.start`
-
-***
-
-### stop()?
-
-> `optional` **stop**(): `Promise`\<`void`\>
-
-The service needs to be stopped when the application is closed.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-Nothing.
-
-#### Inherited from
-
-`IService.stop`

docs/reference/interfaces/ILoggingConnector.md

@@ -39,2 +39,38 @@ [**@gtsc/logging-models**](../overview.md) • **Docs**
 
+### start()?
+
+> `optional` **start**(): `Promise`\<`void`\>
+
+The service needs to be started when the application is initialized.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Inherited from
+
+`IService.start`
+
+***
+
+### stop()?
+
+> `optional` **stop**(): `Promise`\<`void`\>
+
+The service needs to be stopped when the application is closed.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Inherited from
+
+`IService.stop`
+
+***
+
 ### log()
@@ -103,2 +139,8 @@
 
+##### entities
+
+> **entities**: `Partial`\<[`ILogEntry`](ILogEntry.md)\>[]
+
+The entities, which can be partial if a limited keys list was provided.
+
 ##### cursor?
@@ -110,8 +152,2 @@
 
-##### entities
-
-> **entities**: `Partial`\<[`ILogEntry`](ILogEntry.md)\>[]
-
-The entities, which can be partial if a limited keys list was provided.
-
 ##### pageSize?
@@ -132,37 +168,1 @@
 NotImplementedError if the implementation does not support retrieval.
-
-***
-
-### start()?
-
-> `optional` **start**(): `Promise`\<`void`\>
-
-The service needs to be started when the application is initialized.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-Nothing.
-
-#### Inherited from
-
-`IService.start`
-
-***
-
-### stop()?
-
-> `optional` **stop**(): `Promise`\<`void`\>
-
-The service needs to be stopped when the application is closed.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-Nothing.
-
-#### Inherited from
-
-`IService.stop`

docs/reference/interfaces/ILoggingListRequest.md

@@ -17,8 +17,2 @@ [**@gtsc/logging-models**](../overview.md) • **Docs**
 
-#### cursor?
-
-> `optional` **cursor**: `string`
-
-The optional cursor to get next chunk.
-
 #### level?
@@ -30,8 +24,2 @@
 
-#### pageSize?
-
-> `optional` **pageSize**: `number`
-
-The maximum number of entities in a page.
-
 #### source?
@@ -43,2 +31,8 @@
 
+#### timeStart?
+
+> `optional` **timeStart**: `number`
+
+The start time of the metrics to retrieve as a timestamp in ms.
+
 #### timeEnd?
@@ -50,6 +44,12 @@
 
-#### timeStart?
+#### cursor?
 
-> `optional` **timeStart**: `number`
+> `optional` **cursor**: `string`
 
-The start time of the metrics to retrieve as a timestamp in ms.
+The optional cursor to get next chunk.
+
+#### pageSize?
+
+> `optional` **pageSize**: `number`
+
+The maximum number of entities in a page.

docs/reference/interfaces/ILoggingListResponse.md

@@ -17,2 +17,8 @@ [**@gtsc/logging-models**](../overview.md) • **Docs**
 
+#### entities
+
+> **entities**: [`ILogEntry`](ILogEntry.md)[]
+
+The entities, which can be partial if a limited keys list was provided.
+
 #### cursor?
@@ -24,8 +30,2 @@
 
-#### entities
-
-> **entities**: [`ILogEntry`](ILogEntry.md)[]
-
-The entities, which can be partial if a limited keys list was provided.
-
 #### pageSize?
@@ -32,0 +32,0 @@

package.json

 {
 	"name": "@gtsc/logging-models",
-	"version": "0.0.3-next.12",
+	"version": "0.0.3-next.13",
 	"description": "Models which define the structure of the logging connectors and services",
@@ -5,0 +5,0 @@ "repository": {

README.md

@@ -17,3 +17,3 @@ # GTSC Logging Models
 
-Detailed reference documentation for the API can be found in [docs/reference/modules.md](docs/reference/modules.md)
+Detailed reference documentation for the API can be found in [docs/reference/globals.md](docs/reference/globals.md)
 
@@ -20,0 +20,0 @@ ## Changelog

No alert changes

Improved metrics

Lines of code

579

increased by0.17%

Worsened metrics

Total package byte prevSize

50067

decreased by-0.11%

No dependency changes