@vicin/sigil 1.2.4 → 1.2.5

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/CHANGELOG.md CHANGED
@@ -2,7 +2,13 @@
2
2
 
3
3
  All notable changes to this project will be documented in this file.
4
4
 
5
- ## [1.2.4] - 2026-02-11
5
+ ## [1.2.5] - 2026-02-10
6
+
7
+ ### Changed
8
+
9
+ - Documentation updates (README)
10
+
11
+ ## [1.2.4] - 2026-02-10
6
12
 
7
13
  **Stable release**
8
14
 
@@ -10,13 +16,13 @@ All notable changes to this project will be documented in this file.
10
16
 
11
17
  - Documentation updates (README)
12
18
 
13
- ## [1.2.3] - 2026-02-11
19
+ ## [1.2.3] - 2026-02-10
14
20
 
15
21
  ### Changed
16
22
 
17
23
  - Documentation updates (README)
18
24
 
19
- ## [1.2.2] - 2026-02-11
25
+ ## [1.2.2] - 2026-02-10
20
26
 
21
27
  ### Changed
22
28
 
package/README.md CHANGED
@@ -94,7 +94,7 @@ After opting into the `Sigil` contract, labels are passed to child classes to un
94
94
 
95
95
  ##### Decorator pattern
96
96
 
97
- Apply a label with the `@WithSigil` decorator. This is handy for small classes or when you prefer decorator syntax.
97
+ Apply a label with the `@WithSigil` decorator:
98
98
 
99
99
  ```ts
100
100
  import { Sigil, WithSigil } from '@vicin/sigil';
@@ -103,11 +103,9 @@ import { Sigil, WithSigil } from '@vicin/sigil';
103
103
  class User extends Sigil {}
104
104
  ```
105
105
 
106
- > Note: When extending an already sigilified class (for example `Sigil`), you must decorate the subclass or use the HOF helpers in DEV mode unless you configured the library otherwise.
107
-
108
106
  ##### HOF (Higher-Order Function) pattern
109
107
 
110
- HOFs work well in many build setups and are idempotent-safe for HMR flows.
108
+ Apply a label using HOF as `withSigil` or `withSigilTyped`:
111
109
 
112
110
  ```ts
113
111
  import { Sigil, withSigil } from '@vicin/sigil';
@@ -119,6 +117,8 @@ const user = new User();
119
117
  console.log(User.SigilLabel); // "@myorg/mypkg.User"
120
118
  ```
121
119
 
120
+ > Note: When extending an already sigilified class (for example `Sigil`), you must decorate the subclass or use the HOF helpers in DEV mode unless you configured the library otherwise.
121
+
122
122
  ### Minimal “first-run” example
123
123
 
124
124
  ```ts
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vicin/sigil",
3
- "version": "1.2.4",
3
+ "version": "1.2.5",
4
4
  "description": "Lightweight TypeScript library for nominal identity classes",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",