Skip to content

Commit c621c7e

Browse files
committed
Improve type declarations
Improve the type declarations by adding all the configration options and our methods signatures. Publish the type declarations on the NPM package.
1 parent 0bdb526 commit c621c7e

3 files changed

Lines changed: 29 additions & 5 deletions

File tree

index.d.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
11
import * as log from 'loglevel'
22

3+
interface MonkLogOptions {
4+
levelFormatter?: (level: log.LogLevelDesc) => any
5+
timestampFormatter?: (date: Date) => any
6+
nameFormatter?: (name: string) => any
7+
template?: string
8+
}
9+
10+
declare module 'loglevel' {
11+
interface DefaultLogger {
12+
dateToISOString: (d: Date, milliseconds?: boolean) => string
13+
getLogger (name: string, level?: log.LogLevelDesc, options?: MonkLogOptions): log.Logger
14+
}
15+
interface Logger {
16+
configure (options: MonkLogOptions, reset?: boolean): void
17+
getLogger (name: string, level?: log.LogLevelDesc, options?: MonkLogOptions): log.Logger
18+
}
19+
}
20+
321
export = log

package-lock.json

Lines changed: 6 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
11
{
22
"name": "monk-log",
3-
"version": "3.1.0",
3+
"version": "3.2.0",
44
"private": false,
55
"engines": {
66
"node": ">=8.3.0"
77
},
88
"description": "Logging library for Monk projects",
99
"main": "index.js",
10+
"types": "index.d.ts",
1011
"scripts": {
1112
"test": "mocha --colors"
1213
},
1314
"files": [
14-
"lib/"
15+
"lib/",
16+
"index.d.ts"
1517
],
1618
"keywords": [
1719
"monk",
@@ -40,6 +42,5 @@
4042
"repository": {
4143
"type": "git",
4244
"url": "git@git.webmonks.org:node-libraries/monk-log.git"
43-
},
44-
"types": "./index.d.ts"
45+
}
4546
}

0 commit comments

Comments
 (0)