@gtsc/logging-models - npm Package Compare versions

Comparing version 0.0.3-next.29 to 0.0.3-next.30

dist/types/connectors/multiLoggingConnector.d.ts

@@ -11,2 +11,6 @@ import type { EntityCondition, SortDirection } from "@gtsc/entity";
     /**
+     * The namespace for the logging connector.
+     */
+    static readonly NAMESPACE: string;
+    /**
      * Runtime name for the class.
@@ -13,0 +17,0 @@ */

dist/types/connectors/silentLoggingConnector.d.ts

@@ -10,2 +10,6 @@ import type { EntityCondition, SortDirection } from "@gtsc/entity";
     /**
+     * The namespace for the logging connector.
+     */
+    static readonly NAMESPACE: string;
+    /**
      * Runtime name for the class.
@@ -12,0 +16,0 @@ */

dist/types/connectors/systemLoggingConnector.d.ts

@@ -10,2 +10,6 @@ import type { EntityCondition, SortDirection } from "@gtsc/entity";
     /**
+     * The namespace for the logging connector.
+     */
+    static readonly NAMESPACE: string;
+    /**
      * Runtime name for the class.
@@ -17,7 +21,7 @@ */
      * @param options The options for the server.
-     * @param options.loggingConnectorType The type of the logging connector to use, if undefined, no logging will happen.
+     * @param options.loggingConnectorType The type of the logging connector to use, defaults to "logging".
      * @param options.systemPartitionId The system partition id to use when logging information.
      */
     constructor(options: {
-        loggingConnectorType: string;
+        loggingConnectorType?: string;
         systemPartitionId: string;
@@ -24,0 +28,0 @@ });

docs/overview.md

@@ -1,5 +0,1 @@
-[**@gtsc/logging-models**](logging-models/overview.md) • **Docs**
-
-***
-
 # GTSC Logging Models
@@ -17,10 +13,10 @@
 
-Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
+Usage of the APIs is shown in the examples [examples.md](examples.md)
 
 ## Reference
 
-Detailed reference documentation for the API can be found in [docs/reference/globals.md](docs/reference/globals.md)
+Detailed reference documentation for the API can be found in [reference/globals.md](reference/globals.md)
 
 ## Changelog
 
-The changes between each version can be found in [docs/changelog.md](docs/changelog.md)
+The changes between each version can be found in [changelog.md](changelog.md)

docs/reference/classes/LogEntryHelper.md

@@ -1,5 +0,1 @@
-[**@gtsc/logging-models**](../overview.md) • **Docs**
-
-***
-
 # Class: LogEntryHelper
@@ -6,0 +2,0 @@

docs/reference/classes/MultiLoggingConnector.md

@@ -1,5 +0,1 @@
-[**@gtsc/logging-models**](../overview.md) • **Docs**
-
-***
-
 # Class: MultiLoggingConnector
@@ -41,2 +37,10 @@
 
+### NAMESPACE
+
+> `static` `readonly` **NAMESPACE**: `string` = `"multi"`
+
+The namespace for the logging connector.
+
+***
+
 ### CLASS\_NAME
@@ -43,0 +47,0 @@

docs/reference/classes/SilentLoggingConnector.md

@@ -1,5 +0,1 @@
-[**@gtsc/logging-models**](../overview.md) • **Docs**
-
-***
-
 # Class: SilentLoggingConnector
@@ -25,2 +21,10 @@
 
+### NAMESPACE
+
+> `static` `readonly` **NAMESPACE**: `string` = `"silent"`
+
+The namespace for the logging connector.
+
+***
+
 ### CLASS\_NAME
@@ -27,0 +31,0 @@

docs/reference/classes/SystemLoggingConnector.md

@@ -1,5 +0,1 @@
-[**@gtsc/logging-models**](../overview.md) • **Docs**
-
-***
-
 # Class: SystemLoggingConnector
@@ -27,5 +23,5 @@
 
-• **options.loggingConnectorType**: `string`
+• **options.loggingConnectorType?**: `string`
 
-The type of the logging connector to use, if undefined, no logging will happen.
+The type of the logging connector to use, defaults to "logging".
 
@@ -42,2 +38,10 @@ • **options.systemPartitionId**: `string`
 
+### NAMESPACE
+
+> `static` `readonly` **NAMESPACE**: `string` = `"system"`
+
+The namespace for the logging connector.
+
+***
+
 ### CLASS\_NAME
@@ -44,0 +48,0 @@

docs/reference/interfaces/ILogEntry.md

@@ -1,5 +0,1 @@
-[**@gtsc/logging-models**](../overview.md) • **Docs**
-
-***
-
 # Interface: ILogEntry
@@ -6,0 +2,0 @@

docs/reference/interfaces/ILogging.md

@@ -1,5 +0,1 @@
-[**@gtsc/logging-models**](../overview.md) • **Docs**
-
-***
-
 # Interface: ILogging
@@ -29,3 +25,3 @@
 
-> `optional` **bootstrap**(`systemPartitionId`): `Promise`\<`void`\>
+> `optional` **bootstrap**(`systemLoggingConnectorType`?): `Promise`\<`void`\>
 
@@ -36,5 +32,5 @@ Bootstrap the service by creating and initializing any resources it needs.
 
-• **systemPartitionId**: `string`
+• **systemLoggingConnectorType?**: `string`
 
-The system partition id.
+The system logging connector type, defaults to "system-logging".
 
@@ -55,3 +51,3 @@ #### Returns
 
-> `optional` **start**(`systemPartitionId`): `Promise`\<`void`\>
+> `optional` **start**(`systemRequestContext`, `systemLoggingConnectorType`?): `Promise`\<`void`\>
 
@@ -62,6 +58,10 @@ The service needs to be started when the application is initialized.
 
-• **systemPartitionId**: `string`
+• **systemRequestContext**: `IServiceRequestContext`
 
-The system partition id.
+The system request context.
 
+• **systemLoggingConnectorType?**: `string`
+
+The system logging connector type, defaults to "system-logging".
+
 #### Returns
@@ -81,3 +81,3 @@
 
-> `optional` **stop**(`systemPartitionId`): `Promise`\<`void`\>
+> `optional` **stop**(`systemRequestContext`, `systemLoggingConnectorType`?): `Promise`\<`void`\>
 
@@ -88,6 +88,10 @@ The service needs to be stopped when the application is closed.
 
-• **systemPartitionId**: `string`
+• **systemRequestContext**: `IServiceRequestContext`
 
-The system partition id.
+The system request context.
 
+• **systemLoggingConnectorType?**: `string`
+
+The system logging connector type, defaults to "system-logging".
+
 #### Returns
@@ -94,0 +98,0 @@

docs/reference/interfaces/ILoggingConnector.md

@@ -1,5 +0,1 @@
-[**@gtsc/logging-models**](../overview.md) • **Docs**
-
-***
-
 # Interface: ILoggingConnector
@@ -29,3 +25,3 @@
 
-> `optional` **bootstrap**(`systemPartitionId`): `Promise`\<`void`\>
+> `optional` **bootstrap**(`systemLoggingConnectorType`?): `Promise`\<`void`\>
 
@@ -36,5 +32,5 @@ Bootstrap the service by creating and initializing any resources it needs.
 
-• **systemPartitionId**: `string`
+• **systemLoggingConnectorType?**: `string`
 
-The system partition id.
+The system logging connector type, defaults to "system-logging".
 
@@ -55,3 +51,3 @@ #### Returns
 
-> `optional` **start**(`systemPartitionId`): `Promise`\<`void`\>
+> `optional` **start**(`systemRequestContext`, `systemLoggingConnectorType`?): `Promise`\<`void`\>
 
@@ -62,6 +58,10 @@ The service needs to be started when the application is initialized.
 
-• **systemPartitionId**: `string`
+• **systemRequestContext**: `IServiceRequestContext`
 
-The system partition id.
+The system request context.
 
+• **systemLoggingConnectorType?**: `string`
+
+The system logging connector type, defaults to "system-logging".
+
 #### Returns
@@ -81,3 +81,3 @@
 
-> `optional` **stop**(`systemPartitionId`): `Promise`\<`void`\>
+> `optional` **stop**(`systemRequestContext`, `systemLoggingConnectorType`?): `Promise`\<`void`\>
 
@@ -88,6 +88,10 @@ The service needs to be stopped when the application is closed.
 
-• **systemPartitionId**: `string`
+• **systemRequestContext**: `IServiceRequestContext`
 
-The system partition id.
+The system request context.
 
+• **systemLoggingConnectorType?**: `string`
+
+The system logging connector type, defaults to "system-logging".
+
 #### Returns
@@ -94,0 +98,0 @@

docs/reference/interfaces/ILoggingCreateRequest.md

@@ -1,5 +0,1 @@
-[**@gtsc/logging-models**](../overview.md) • **Docs**
-
-***
-
 # Interface: ILoggingCreateRequest
@@ -6,0 +2,0 @@

docs/reference/interfaces/ILoggingLevelsConfig.md

@@ -1,5 +0,1 @@
-[**@gtsc/logging-models**](../overview.md) • **Docs**
-
-***
-
 # Interface: ILoggingLevelsConfig
@@ -6,0 +2,0 @@

docs/reference/interfaces/ILoggingListRequest.md

@@ -1,5 +0,1 @@
-[**@gtsc/logging-models**](../overview.md) • **Docs**
-
-***
-
 # Interface: ILoggingListRequest
@@ -6,0 +2,0 @@

docs/reference/interfaces/ILoggingListResponse.md

@@ -1,5 +0,1 @@
-[**@gtsc/logging-models**](../overview.md) • **Docs**
-
-***
-
 # Interface: ILoggingListResponse
@@ -6,0 +2,0 @@

docs/reference/type-aliases/LogLevel.md

@@ -1,5 +0,1 @@
-[**@gtsc/logging-models**](../overview.md) • **Docs**
-
-***
-
 # Type alias: LogLevel
@@ -6,0 +2,0 @@

docs/reference/variables/LoggingConnectorFactory.md

@@ -1,5 +0,1 @@
-[**@gtsc/logging-models**](../overview.md) • **Docs**
-
-***
-
 # Variable: LoggingConnectorFactory
@@ -6,0 +2,0 @@

package.json

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

No alert changes

Improved metrics

Total package byte prevSize

65952

increased by1.71%

Lines of code

872

increased by4.31%

No dependency changes