@ncfour-us/logging 0.0.17 → 0.0.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +59 -2
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,7 +1,44 @@
|
|
|
1
|
-
# @
|
|
1
|
+
# @ncfour-us/logging
|
|
2
2
|
|
|
3
3
|
This project implements a simple logger and a proxy for winston logger.
|
|
4
4
|
|
|
5
|
+
## Badges
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
<!--
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
-->
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
## Table of Contents
|
|
24
|
+
|
|
25
|
+
- [Installation](#installation)
|
|
26
|
+
- [Getting Started](#getting-started)
|
|
27
|
+
- [Contributing](#contributing)
|
|
28
|
+
- [License](#license)
|
|
29
|
+
- [Authors](#authors)
|
|
30
|
+
- [Acknowledgements](#acknowledgements)
|
|
31
|
+
|
|
32
|
+
## Installation
|
|
33
|
+
|
|
34
|
+
Install using `npm`, `yarn`, or `pnpm` (preferred).
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
pnpm add @ncfour-us/logging
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Getting Started
|
|
41
|
+
|
|
5
42
|
The package exports an `ILogger` interface along with a `createLogger()` function.
|
|
6
43
|
|
|
7
44
|
The return value from `createLogger()` is a `ILogger` which can then be used
|
|
@@ -9,4 +46,24 @@ to log activities in the application.
|
|
|
9
46
|
|
|
10
47
|
The package can be used in either browser-based or Node-based runtime environments.
|
|
11
48
|
|
|
12
|
-
|
|
49
|
+
To use the logger, call `createLogger()`:
|
|
50
|
+
|
|
51
|
+
```typescript
|
|
52
|
+
import { ILogger, createLogger } from '@ncfour-us/logging';
|
|
53
|
+
|
|
54
|
+
const myLogger: ILogger = createLogger('simple');
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Contributing
|
|
58
|
+
|
|
59
|
+
Fork this repository and submit a PR.
|
|
60
|
+
|
|
61
|
+
## Authors
|
|
62
|
+
|
|
63
|
+
- Tim Hahn ([hahntj@gmail.com](mailto:hahntj@gmail.com), github: @climbertjh)
|
|
64
|
+
|
|
65
|
+
## License
|
|
66
|
+
|
|
67
|
+
The project is covered by the MIT license, see [LICENSE](./LICENSE).
|
|
68
|
+
|
|
69
|
+
## Acknowledgements
|
package/package.json
CHANGED
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
"@eslint/eslintrc": "^3.3.5",
|
|
15
15
|
"@eslint/js": "^9.39.4",
|
|
16
16
|
"@jest/globals": "^29.7.0",
|
|
17
|
-
"@ncfour-us/projen-utils": "
|
|
17
|
+
"@ncfour-us/projen-utils": "^0.1.1",
|
|
18
18
|
"@stylistic/eslint-plugin": "^5.10.0",
|
|
19
19
|
"@types/jest": "^29.5.14",
|
|
20
20
|
"@types/node": "^24",
|
|
@@ -58,7 +58,7 @@
|
|
|
58
58
|
},
|
|
59
59
|
"main": "lib/index.js",
|
|
60
60
|
"license": "MIT",
|
|
61
|
-
"version": "0.0.
|
|
61
|
+
"version": "0.0.20",
|
|
62
62
|
"jest": {
|
|
63
63
|
"coverageProvider": "v8",
|
|
64
64
|
"extensionsToTreatAsEsm": [
|