@pencroff-lab/kore 0.1.1 → 0.2.0
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 +40 -1
- package/dist/cjs/src/utils/format_dt.d.ts +71 -1
- package/dist/cjs/src/utils/format_dt.d.ts.map +1 -1
- package/dist/cjs/src/utils/format_dt.js +50 -6
- package/dist/cjs/src/utils/format_dt.js.map +1 -1
- package/dist/cjs/src/utils/index.d.ts +1 -0
- package/dist/cjs/src/utils/index.d.ts.map +1 -1
- package/dist/cjs/src/utils/index.js +1 -0
- package/dist/cjs/src/utils/index.js.map +1 -1
- package/dist/cjs/src/utils/logger.d.ts +271 -0
- package/dist/cjs/src/utils/logger.d.ts.map +1 -0
- package/dist/cjs/src/utils/logger.js +340 -0
- package/dist/cjs/src/utils/logger.js.map +1 -0
- package/dist/esm/src/utils/format_dt.d.ts +71 -1
- package/dist/esm/src/utils/format_dt.d.ts.map +1 -1
- package/dist/esm/src/utils/format_dt.js +50 -6
- package/dist/esm/src/utils/format_dt.js.map +1 -1
- package/dist/esm/src/utils/index.d.ts +1 -0
- package/dist/esm/src/utils/index.d.ts.map +1 -1
- package/dist/esm/src/utils/index.js +1 -0
- package/dist/esm/src/utils/index.js.map +1 -1
- package/dist/esm/src/utils/logger.d.ts +271 -0
- package/dist/esm/src/utils/logger.d.ts.map +1 -0
- package/dist/esm/src/utils/logger.js +335 -0
- package/dist/esm/src/utils/logger.js.map +1 -0
- package/docs/err.md +897 -0
- package/docs/format_dt.md +159 -0
- package/docs/logger.md +342 -0
- package/docs/logging_guide.md +427 -0
- package/docs/outcome.md +831 -0
- package/llms.txt +24 -0
- package/package.json +7 -2
package/llms.txt
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# @pencroff-lab/kore
|
|
2
|
+
|
|
3
|
+
> TypeScript core utilities library providing value-based error handling types inspired by Go-style error handling. Published as a dual ESM/CJS package.
|
|
4
|
+
|
|
5
|
+
## Modules
|
|
6
|
+
|
|
7
|
+
- [Err](docs/err.md): Immutable, value-based error type. Supports wrapping (cause chains), aggregation (multiple errors), hierarchical error codes, JSON serialization/deserialization, and conversion to native Error.
|
|
8
|
+
- [Outcome](docs/outcome.md): Monadic container wrapping ResultTuple<T> ([T, null] | [null, Err]). Supports map/mapErr/pipe/pipeAsync chains, combinators (all, any), side effects (effect), and terminal operations (toTuple, defaultTo, either).
|
|
9
|
+
- [dtStamp](docs/format_dt.md): Format a Date into a filesystem/log-safe timestamp string. Produces compact, sortable stamps suitable for file names, log prefixes, and identifiers.
|
|
10
|
+
- [Logger](docs/logger.md): Structured logging utility with transport DI and Err integration. Callable function with overloaded signatures, child loggers, pretty console transport, and automatic Err formatting.
|
|
11
|
+
- [Logging Guide](docs/logging_guide.md): Usage patterns, DI conventions, error logging strategy, and integration examples.
|
|
12
|
+
|
|
13
|
+
## Quick Start
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { Err, Outcome } from "@pencroff-lab/kore/types";
|
|
17
|
+
import { dtStamp, log, createLogger } from "@pencroff-lab/kore/utils";
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Install
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npm install @pencroff-lab/kore
|
|
24
|
+
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pencroff-lab/kore",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "Core utilities library",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": "Pencroff",
|
|
@@ -25,7 +25,9 @@
|
|
|
25
25
|
},
|
|
26
26
|
"sideEffects": false,
|
|
27
27
|
"files": [
|
|
28
|
-
"dist"
|
|
28
|
+
"dist",
|
|
29
|
+
"docs",
|
|
30
|
+
"llms.txt"
|
|
29
31
|
],
|
|
30
32
|
"scripts": {
|
|
31
33
|
"test": "bun test",
|
|
@@ -52,5 +54,8 @@
|
|
|
52
54
|
},
|
|
53
55
|
"peerDependencies": {
|
|
54
56
|
"typescript": "5.9.3"
|
|
57
|
+
},
|
|
58
|
+
"dependencies": {
|
|
59
|
+
"fast-safe-stringify": "2.1.1"
|
|
55
60
|
}
|
|
56
61
|
}
|