@twin.org/tools-core 0.0.3-next.28 → 0.0.3-next.29
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/dist/es/utils/jsDoc.js +18 -0
- package/dist/es/utils/jsDoc.js.map +1 -1
- package/dist/es/utils/jsonSchemaBuilder.js +7 -0
- package/dist/es/utils/jsonSchemaBuilder.js.map +1 -1
- package/dist/types/utils/jsDoc.d.ts +7 -0
- package/docs/changelog.md +14 -0
- package/docs/reference/classes/JsDoc.md +28 -0
- package/package.json +2 -2
|
@@ -35,6 +35,13 @@ export declare class JsDoc {
|
|
|
35
35
|
* @returns The trimmed comment text, or undefined when absent.
|
|
36
36
|
*/
|
|
37
37
|
static getNodeTagComment(node: ts.Node, tagName: string): string | undefined;
|
|
38
|
+
/**
|
|
39
|
+
* Read the plain comment text for all matching JSDoc tags on a node.
|
|
40
|
+
* @param node The node to inspect.
|
|
41
|
+
* @param tagName The tag name to filter by (e.g., 'example').
|
|
42
|
+
* @returns An array of trimmed comment texts for all matching tags.
|
|
43
|
+
*/
|
|
44
|
+
static getNodeTagComments(node: ts.Node, tagName: string): string[];
|
|
38
45
|
/**
|
|
39
46
|
* Parse a custom JSDoc tag value into JSON-compatible data.
|
|
40
47
|
* Values that begin with a JSON token character (open brace, open bracket, double quote, true, false, null) or look like a
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.3-next.29](https://github.com/iotaledger/twin-tools/compare/tools-core-v0.0.3-next.28...tools-core-v0.0.3-next.29) (2026-05-14)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* add examples to json schema ([#109](https://github.com/iotaledger/twin-tools/issues/109)) ([def5b13](https://github.com/iotaledger/twin-tools/commit/def5b1312e7a0ffefe662fb14575cb655d1c0774))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Dependencies
|
|
12
|
+
|
|
13
|
+
* The following workspace dependencies were updated
|
|
14
|
+
* dependencies
|
|
15
|
+
* @twin.org/tools-models bumped from 0.0.3-next.28 to 0.0.3-next.29
|
|
16
|
+
|
|
3
17
|
## [0.0.3-next.28](https://github.com/iotaledger/twin-tools/compare/tools-core-v0.0.3-next.27...tools-core-v0.0.3-next.28) (2026-05-11)
|
|
4
18
|
|
|
5
19
|
|
|
@@ -118,6 +118,34 @@ The trimmed comment text, or undefined when absent.
|
|
|
118
118
|
|
|
119
119
|
***
|
|
120
120
|
|
|
121
|
+
### getNodeTagComments() {#getnodetagcomments}
|
|
122
|
+
|
|
123
|
+
> `static` **getNodeTagComments**(`node`, `tagName`): `string`[]
|
|
124
|
+
|
|
125
|
+
Read the plain comment text for all matching JSDoc tags on a node.
|
|
126
|
+
|
|
127
|
+
#### Parameters
|
|
128
|
+
|
|
129
|
+
##### node
|
|
130
|
+
|
|
131
|
+
`Node`
|
|
132
|
+
|
|
133
|
+
The node to inspect.
|
|
134
|
+
|
|
135
|
+
##### tagName
|
|
136
|
+
|
|
137
|
+
`string`
|
|
138
|
+
|
|
139
|
+
The tag name to filter by (e.g., 'example').
|
|
140
|
+
|
|
141
|
+
#### Returns
|
|
142
|
+
|
|
143
|
+
`string`[]
|
|
144
|
+
|
|
145
|
+
An array of trimmed comment texts for all matching tags.
|
|
146
|
+
|
|
147
|
+
***
|
|
148
|
+
|
|
121
149
|
### parseTagValue() {#parsetagvalue}
|
|
122
150
|
|
|
123
151
|
> `static` **parseTagValue**(`value`): `unknown`
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/tools-core",
|
|
3
|
-
"version": "0.0.3-next.
|
|
3
|
+
"version": "0.0.3-next.29",
|
|
4
4
|
"description": "Shared utilities and models for tooling packages",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
"dependencies": {
|
|
17
17
|
"@twin.org/core": "next",
|
|
18
18
|
"@twin.org/nameof": "next",
|
|
19
|
-
"@twin.org/tools-models": "0.0.3-next.
|
|
19
|
+
"@twin.org/tools-models": "0.0.3-next.29",
|
|
20
20
|
"glob": "13.0.6"
|
|
21
21
|
},
|
|
22
22
|
"main": "./dist/es/index.js",
|