@gtsc/logging-models
Advanced tools
Comparing version 0.0.3-next.32 to 0.0.5-next.1
import type { EntityCondition, SortDirection } from "@gtsc/entity"; | ||
import type { IServiceRequestContext } from "@gtsc/services"; | ||
import type { ILogEntry } from "../models/ILogEntry"; | ||
@@ -39,6 +38,5 @@ import type { ILoggingConnector } from "../models/ILoggingConnector"; | ||
* @param logEntry The entry to log. | ||
* @param requestContext The context for the request. | ||
* @returns Nothing. | ||
*/ | ||
log(logEntry: ILogEntry, requestContext?: IServiceRequestContext): Promise<void>; | ||
log(logEntry: ILogEntry): Promise<void>; | ||
/** | ||
@@ -51,3 +49,2 @@ * Query the log entries. | ||
* @param pageSize The maximum number of entities in a page. | ||
* @param requestContext The context for the request. | ||
* @returns All the entities for the storage matching the conditions, | ||
@@ -60,3 +57,3 @@ * and a cursor which can be used to request more entities. | ||
sortDirection: SortDirection; | ||
}[], properties?: (keyof ILogEntry)[], cursor?: string, pageSize?: number, requestContext?: IServiceRequestContext): Promise<{ | ||
}[], properties?: (keyof ILogEntry)[], cursor?: string, pageSize?: number): Promise<{ | ||
/** | ||
@@ -63,0 +60,0 @@ * The entities, which can be partial if a limited keys list was provided. |
import type { EntityCondition, SortDirection } from "@gtsc/entity"; | ||
import type { IServiceRequestContext } from "@gtsc/services"; | ||
import type { ILogEntry } from "../models/ILogEntry"; | ||
@@ -20,6 +19,5 @@ import type { ILoggingConnector } from "../models/ILoggingConnector"; | ||
* @param logEntry The entry to log. | ||
* @param requestContext The context for the request. | ||
* @returns Nothing. | ||
*/ | ||
log(logEntry: ILogEntry, requestContext?: IServiceRequestContext): Promise<void>; | ||
log(logEntry: ILogEntry): Promise<void>; | ||
/** | ||
@@ -32,3 +30,2 @@ * Query the log entries. | ||
* @param pageSize The maximum number of entities in a page. | ||
* @param requestContext The context for the request. | ||
* @returns All the entities for the storage matching the conditions, | ||
@@ -41,3 +38,3 @@ * and a cursor which can be used to request more entities. | ||
sortDirection: SortDirection; | ||
}[], properties?: (keyof ILogEntry)[], cursor?: string, pageSize?: number, requestContext?: IServiceRequestContext): Promise<{ | ||
}[], properties?: (keyof ILogEntry)[], cursor?: string, pageSize?: number): Promise<{ | ||
/** | ||
@@ -44,0 +41,0 @@ * The entities, which can be partial if a limited keys list was provided. |
export * from "./connectors/multiLoggingConnector"; | ||
export * from "./connectors/silentLoggingConnector"; | ||
export * from "./connectors/systemLoggingConnector"; | ||
export * from "./factories/loggingConnectorFactory"; | ||
@@ -5,0 +4,0 @@ export * from "./helpers/logEntryHelper"; |
@@ -1,2 +0,2 @@ | ||
import type { IService, IServiceRequestContext } from "@gtsc/services"; | ||
import type { IService } from "@gtsc/services"; | ||
import type { ILogEntry } from "./ILogEntry"; | ||
@@ -11,6 +11,5 @@ import type { LogLevel } from "./logLevel"; | ||
* @param logEntry The entry to log. | ||
* @param requestContext The context for the request. | ||
* @returns Nothing. | ||
*/ | ||
log(logEntry: ILogEntry, requestContext?: IServiceRequestContext): Promise<void>; | ||
log(logEntry: ILogEntry): Promise<void>; | ||
/** | ||
@@ -24,3 +23,2 @@ * Query the log entries. | ||
* @param pageSize The maximum number of entities in a page. | ||
* @param requestContext The context for the request. | ||
* @returns All the entities for the storage matching the conditions, | ||
@@ -30,3 +28,3 @@ * and a cursor which can be used to request more entities. | ||
*/ | ||
query(level?: LogLevel, source?: string, timeStart?: number, timeEnd?: number, cursor?: string, pageSize?: number, requestContext?: IServiceRequestContext): Promise<{ | ||
query(level?: LogLevel, source?: string, timeStart?: number, timeEnd?: number, cursor?: string, pageSize?: number): Promise<{ | ||
/** | ||
@@ -33,0 +31,0 @@ * The entities, which can be partial if a limited keys list was provided. |
import type { EntityCondition, SortDirection } from "@gtsc/entity"; | ||
import type { IService, IServiceRequestContext } from "@gtsc/services"; | ||
import type { IService } from "@gtsc/services"; | ||
import type { ILogEntry } from "./ILogEntry"; | ||
@@ -11,6 +11,5 @@ /** | ||
* @param logEntry The entry to log. | ||
* @param requestContext The context for the request. | ||
* @returns Nothing. | ||
*/ | ||
log(logEntry: ILogEntry, requestContext?: IServiceRequestContext): Promise<void>; | ||
log(logEntry: ILogEntry): Promise<void>; | ||
/** | ||
@@ -23,3 +22,2 @@ * Query the log entries. | ||
* @param pageSize The maximum number of entities in a page. | ||
* @param requestContext The context for the request. | ||
* @returns All the entities for the storage matching the conditions, | ||
@@ -32,3 +30,3 @@ * and a cursor which can be used to request more entities. | ||
sortDirection: SortDirection; | ||
}[], properties?: (keyof ILogEntry)[], cursor?: string, pageSize?: number, requestContext?: IServiceRequestContext): Promise<{ | ||
}[], properties?: (keyof ILogEntry)[], cursor?: string, pageSize?: number): Promise<{ | ||
/** | ||
@@ -35,0 +33,0 @@ * The entities, which can be partial if a limited keys list was provided. |
@@ -75,3 +75,3 @@ # Class: MultiLoggingConnector | ||
> **log**(`logEntry`, `requestContext`?): `Promise`\<`void`\> | ||
> **log**(`logEntry`): `Promise`\<`void`\> | ||
@@ -86,6 +86,2 @@ Log an entry to the connector. | ||
• **requestContext?**: `IServiceRequestContext` | ||
The context for the request. | ||
#### Returns | ||
@@ -105,3 +101,3 @@ | ||
> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?, `requestContext`?): `Promise`\<`object`\> | ||
> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<`object`\> | ||
@@ -132,6 +128,2 @@ Query the log entries. | ||
• **requestContext?**: `IServiceRequestContext` | ||
The context for the request. | ||
#### Returns | ||
@@ -138,0 +130,0 @@ |
@@ -43,3 +43,3 @@ # Class: SilentLoggingConnector | ||
> **log**(`logEntry`, `requestContext`?): `Promise`\<`void`\> | ||
> **log**(`logEntry`): `Promise`\<`void`\> | ||
@@ -54,6 +54,2 @@ Log an entry to the connector. | ||
• **requestContext?**: `IServiceRequestContext` | ||
The context for the request. | ||
#### Returns | ||
@@ -73,3 +69,3 @@ | ||
> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?, `requestContext`?): `Promise`\<`object`\> | ||
> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<`object`\> | ||
@@ -100,6 +96,2 @@ Query the log entries. | ||
• **requestContext?**: `IServiceRequestContext` | ||
The context for the request. | ||
#### Returns | ||
@@ -106,0 +98,0 @@ |
@@ -7,3 +7,2 @@ # @gtsc/logging-models | ||
- [SilentLoggingConnector](classes/SilentLoggingConnector.md) | ||
- [SystemLoggingConnector](classes/SystemLoggingConnector.md) | ||
- [LogEntryHelper](classes/LogEntryHelper.md) | ||
@@ -10,0 +9,0 @@ |
@@ -105,3 +105,3 @@ # Interface: ILogging | ||
> **log**(`logEntry`, `requestContext`?): `Promise`\<`void`\> | ||
> **log**(`logEntry`): `Promise`\<`void`\> | ||
@@ -116,6 +116,2 @@ Log an entry to the service. | ||
• **requestContext?**: `IServiceRequestContext` | ||
The context for the request. | ||
#### Returns | ||
@@ -131,3 +127,3 @@ | ||
> **query**(`level`?, `source`?, `timeStart`?, `timeEnd`?, `cursor`?, `pageSize`?, `requestContext`?): `Promise`\<`object`\> | ||
> **query**(`level`?, `source`?, `timeStart`?, `timeEnd`?, `cursor`?, `pageSize`?): `Promise`\<`object`\> | ||
@@ -162,6 +158,2 @@ Query the log entries. | ||
• **requestContext?**: `IServiceRequestContext` | ||
The context for the request. | ||
#### Returns | ||
@@ -168,0 +160,0 @@ |
@@ -105,3 +105,3 @@ # Interface: ILoggingConnector | ||
> **log**(`logEntry`, `requestContext`?): `Promise`\<`void`\> | ||
> **log**(`logEntry`): `Promise`\<`void`\> | ||
@@ -116,6 +116,2 @@ Log an entry to the connector. | ||
• **requestContext?**: `IServiceRequestContext` | ||
The context for the request. | ||
#### Returns | ||
@@ -131,3 +127,3 @@ | ||
> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?, `requestContext`?): `Promise`\<`object`\> | ||
> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<`object`\> | ||
@@ -158,6 +154,2 @@ Query the log entries. | ||
• **requestContext?**: `IServiceRequestContext` | ||
The context for the request. | ||
#### Returns | ||
@@ -164,0 +156,0 @@ |
{ | ||
"name": "@gtsc/logging-models", | ||
"version": "0.0.3-next.32", | ||
"version": "0.0.5-next.1", | ||
"description": "Models which define the structure of the logging connectors and services", | ||
@@ -5,0 +5,0 @@ "repository": { |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
53042
35
669