From c0610ecb4345787666c0b6de3cd35394a4670e1d Mon Sep 17 00:00:00 2001 From: Alexey Prokhorov Date: Wed, 13 Dec 2023 17:39:45 +0500 Subject: [PATCH] fix(type): Set the exact Logger.create return type, closes #382 --- src/__specs__/index.d.main.test.ts | 15 +++++++++++++++ src/__specs__/index.d.renderer.test.ts | 11 +++++++++++ src/__specs__/index.d.test.ts | 17 ----------------- src/index.d.ts | 2 +- tsconfig.json | 2 +- 5 files changed, 28 insertions(+), 19 deletions(-) create mode 100644 src/__specs__/index.d.main.test.ts create mode 100644 src/__specs__/index.d.renderer.test.ts delete mode 100644 src/__specs__/index.d.test.ts diff --git a/src/__specs__/index.d.main.test.ts b/src/__specs__/index.d.main.test.ts new file mode 100644 index 0000000..aee5622 --- /dev/null +++ b/src/__specs__/index.d.main.test.ts @@ -0,0 +1,15 @@ +import defaultLog from '../../main'; +import { ConsoleTransport, warn } from '../index'; + +// Default module export +defaultLog.warn('test'); + +// Check whether default logger is MainLogger +defaultLog.create({ logId: 'test '}).transports.file.level = 'error'; + +// CommonJS export +warn('test'); + +// Check named export +const transport: ConsoleTransport = defaultLog.transports.console +transport({ data: [], date: new Date(), level: 'info' }) diff --git a/src/__specs__/index.d.renderer.test.ts b/src/__specs__/index.d.renderer.test.ts new file mode 100644 index 0000000..2c89e2c --- /dev/null +++ b/src/__specs__/index.d.renderer.test.ts @@ -0,0 +1,11 @@ +import defaultLog from '../../renderer'; +import { warn } from '../index'; + +// Default module export +defaultLog.warn('test'); + +// CommonJS export +warn('test'); + +// Check global variable +__electronLog.info(); diff --git a/src/__specs__/index.d.test.ts b/src/__specs__/index.d.test.ts deleted file mode 100644 index 80979da..0000000 --- a/src/__specs__/index.d.test.ts +++ /dev/null @@ -1,17 +0,0 @@ -import defaultLog from '../index'; -import { create, ConsoleTransport, warn } from '../index'; - -// Default module export -defaultLog.warn('test'); - -// CommonJS export -warn('test'); - -// Type export -const transport: ConsoleTransport = defaultLog.transports.console -transport({ data: [], date: new Date(), level: 'info' }) - -const newInstance = create({ logId: 'test' }); -newInstance.info('test'); - -__electronLog.info(); diff --git a/src/index.d.ts b/src/index.d.ts index 8f3c78c..5a0220c 100644 --- a/src/index.d.ts +++ b/src/index.d.ts @@ -604,7 +604,7 @@ declare namespace Logger { /** * Create a new electron-log instance */ - create(options: { logId: string }): Logger.Logger; + create(options: { logId: string }): this; /** * Low level method which logs the message using specified transports diff --git a/tsconfig.json b/tsconfig.json index 9bce857..b2502df 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -5,6 +5,6 @@ "noImplicitReturns": true }, "include": [ - "./src/__specs__/index.d.test.ts" + "./src/__specs__/index.d.*.ts", ] }