From 7cd01231b50d4019c0cf36cf308f6b09168dbdb1 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Thu, 15 Dec 2022 13:47:41 +0100 Subject: [PATCH] backend-plugin-api: separate out Error from LogMeta + limit to indexed objects Co-authored-by: Johan Haals Signed-off-by: Patrik Oldsberg --- packages/backend-plugin-api/api-report.md | 16 +++++++--------- .../src/services/definitions/loggerServiceRef.ts | 10 +++++----- 2 files changed, 12 insertions(+), 14 deletions(-) diff --git a/packages/backend-plugin-api/api-report.md b/packages/backend-plugin-api/api-report.md index bbc0a39518..545728b386 100644 --- a/packages/backend-plugin-api/api-report.md +++ b/packages/backend-plugin-api/api-report.md @@ -207,13 +207,13 @@ export interface LoggerService { // (undocumented) child(meta: LogMeta): LoggerService; // (undocumented) - debug(message: string, meta?: LogMeta): void; + debug(message: string, meta?: Error | LogMeta): void; // (undocumented) - error(message: string, meta?: LogMeta): void; + error(message: string, meta?: Error | LogMeta): void; // (undocumented) - info(message: string, meta?: LogMeta): void; + info(message: string, meta?: Error | LogMeta): void; // (undocumented) - warn(message: string, meta?: LogMeta): void; + warn(message: string, meta?: Error | LogMeta): void; } // @public (undocumented) @@ -226,11 +226,9 @@ export function loggerToWinstonLogger( ): Logger; // @public (undocumented) -export type LogMeta = - | Error - | { - [name: string]: any; - }; +export type LogMeta = { + [name: string]: unknown; +}; // @public (undocumented) export type PermissionsService = PermissionEvaluator | PermissionAuthorizer; diff --git a/packages/backend-plugin-api/src/services/definitions/loggerServiceRef.ts b/packages/backend-plugin-api/src/services/definitions/loggerServiceRef.ts index 179e97a84b..1c094549c1 100644 --- a/packages/backend-plugin-api/src/services/definitions/loggerServiceRef.ts +++ b/packages/backend-plugin-api/src/services/definitions/loggerServiceRef.ts @@ -19,16 +19,16 @@ import { createServiceRef } from '../system/types'; /** * @public */ -export type LogMeta = Error | { [name: string]: any }; +export type LogMeta = { [name: string]: unknown }; /** * @public */ export interface LoggerService { - error(message: string, meta?: LogMeta): void; - warn(message: string, meta?: LogMeta): void; - info(message: string, meta?: LogMeta): void; - debug(message: string, meta?: LogMeta): void; + error(message: string, meta?: Error | LogMeta): void; + warn(message: string, meta?: Error | LogMeta): void; + info(message: string, meta?: Error | LogMeta): void; + debug(message: string, meta?: Error | LogMeta): void; child(meta: LogMeta): LoggerService; }