@lytical/jxf 1.0.0 → 1.0.1
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 +5 -0
- package/package.json +4 -4
- package/types.d.ts +3 -0
package/README.md
CHANGED
|
@@ -19,6 +19,11 @@ Supports ES6 environments in both DOM and NodeJS.
|
|
|
19
19
|
|
|
20
20
|
After installing JXF, import and invoke the `jxf()` function. DSL usage documentation can be found in [JSPath]('https://www.npmjs.com/package/jspath').
|
|
21
21
|
|
|
22
|
+
**Please note:**
|
|
23
|
+
The current version of (@types/jspath@0.4.2) is outdated and does not properly exports the default apply() function.
|
|
24
|
+
Until this is corrected, you must `npm install -D @types/jspath` as a dev dependency to avoid TypeScript compile errors.
|
|
25
|
+
see: https://www.npmjs.com/package/@types/jspath
|
|
26
|
+
|
|
22
27
|
## Usage
|
|
23
28
|
|
|
24
29
|
```javascript
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lytical/jxf",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "A TypeScript library for transforming template declarations into formatted strings based on provided data.",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"private": false,
|
|
@@ -36,8 +36,7 @@
|
|
|
36
36
|
"dependencies": {
|
|
37
37
|
"chai": "^6.2.2",
|
|
38
38
|
"jspath": "^0.4.0",
|
|
39
|
-
"mocha": "^11.7.5"
|
|
40
|
-
"typescript": "^5.9.3"
|
|
39
|
+
"mocha": "^11.7.5"
|
|
41
40
|
},
|
|
42
41
|
"devDependencies": {
|
|
43
42
|
"@types/chai": "^5.2.3",
|
|
@@ -47,6 +46,7 @@
|
|
|
47
46
|
"gulp": "^5.0.1",
|
|
48
47
|
"gulp-uglify-es": "^3.0.0",
|
|
49
48
|
"pump": "^3.0.3",
|
|
50
|
-
"rimraf": "^6.1.2"
|
|
49
|
+
"rimraf": "^6.1.2",
|
|
50
|
+
"typescript": "^5.9.3"
|
|
51
51
|
}
|
|
52
52
|
}
|
package/types.d.ts
CHANGED
|
@@ -39,6 +39,9 @@ export type jxf_ctx_t = Record<string, any>;
|
|
|
39
39
|
export type jxf_transformer_t = (data: any, ctx: jxf_ctx_t) => string[];
|
|
40
40
|
|
|
41
41
|
// the current version of (@types/jspath@0.4.2) is outdated and does not properly exports the default apply() function.
|
|
42
|
+
// once an updated version is available, this module declaration can be removed.
|
|
43
|
+
// for now, you must npm install @types/jspath as a dev dependency to avoid TypeScript errors.
|
|
44
|
+
// see: https://www.npmjs.com/package/@types/jspath
|
|
42
45
|
declare module 'jspath' {
|
|
43
46
|
export default function apply<_t_ = any>(
|
|
44
47
|
path: string,
|