textmode.export.js 1.5.0 → 1.5.2
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 +2 -2
- package/dist/textmode.export.esm.js +1235 -1164
- package/dist/textmode.export.umd.js +5 -5
- package/dist/types/augmentations/index.d.ts +5 -0
- package/dist/types/augmentations/index.d.ts.map +1 -0
- package/dist/types/augmentations/textmode.d.ts +9 -0
- package/dist/types/augmentations/textmode.d.ts.map +1 -0
- package/dist/types/augmentations/textmode.test.d.ts +2 -0
- package/dist/types/augmentations/textmode.test.d.ts.map +1 -0
- package/dist/types/exporters/base/LayerTarget.d.ts +4 -0
- package/dist/types/exporters/base/LayerTarget.d.ts.map +1 -1
- package/dist/types/exporters/gif/types.d.ts +24 -0
- package/dist/types/exporters/gif/types.d.ts.map +1 -1
- package/dist/types/exporters/image/types.d.ts +8 -0
- package/dist/types/exporters/image/types.d.ts.map +1 -1
- package/dist/types/exporters/json/types.d.ts +36 -0
- package/dist/types/exporters/json/types.d.ts.map +1 -1
- package/dist/types/exporters/svg/types.d.ts +2 -0
- package/dist/types/exporters/svg/types.d.ts.map +1 -1
- package/dist/types/exporters/txt/types.d.ts +2 -0
- package/dist/types/exporters/txt/types.d.ts.map +1 -1
- package/dist/types/exporters/video/VideoFrameDriver.d.ts.map +1 -1
- package/dist/types/exporters/video/VideoRecorder.d.ts +4 -0
- package/dist/types/exporters/video/VideoRecorder.d.ts.map +1 -1
- package/dist/types/exporters/video/errors.d.ts +1 -0
- package/dist/types/exporters/video/errors.d.ts.map +1 -1
- package/dist/types/exporters/video/types.d.ts +64 -2
- package/dist/types/exporters/video/types.d.ts.map +1 -1
- package/dist/types/exporters/video/withAbortableTimeout.d.ts +2 -0
- package/dist/types/exporters/video/withAbortableTimeout.d.ts.map +1 -0
- package/dist/types/index.d.ts +5 -0
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/types.d.ts +40 -0
- package/dist/types/types.d.ts.map +1 -1
- package/package.json +3 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/exporters/video/types.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/exporters/video/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,WAAW,GAAG,UAAU,GAAG,WAAW,GAAG,OAAO,CAAC;AAE5F;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,WAAW,GAAG,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,YAAY,CAAC;AAE9G,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAE/D;;;;;;;GAOG;AACH,MAAM,MAAM,kBAAkB,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC;AAE3D;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,KAAK,CAAC;AAE/C;;;;;;;;;GASG;AACH,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,UAAU,CAAC;AAEvD;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,UAAU,CAAC;AAEtD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,yBAAyB,GAAG,eAAe,GAAG,iBAAiB,GAAG,iBAAiB,CAAC;AAEhG,MAAM,MAAM,oBAAoB,GAC7B,0BAA0B,GAC1B,yBAAyB,GACzB,sBAAsB,GACtB,sBAAsB,GACtB,qBAAqB,GACrB,gCAAgC,CAAC;AAEpC;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IACjC;;;;OAIG;IACH,KAAK,EAAE,mBAAmB,CAAC;IAC3B;;;;OAIG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAChC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;IACtC;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,gBAAgB,CAAC;IAC/B;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,gBAAgB,CAAC;IAC/B;;;;;;;OAOG;IACH,oBAAoB,CAAC,EAAE,yBAAyB,CAAC;IACjD;;;;;;;;OAQG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;OAIG;IACH,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,mBAAmB,KAAK,IAAI,CAAC;IACrD;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,WAAW,sBAAsB;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,GAAG,kBAAkB,CAAC;IACrC,WAAW,EAAE,gBAAgB,CAAC;IAC9B,WAAW,EAAE,gBAAgB,CAAC;IAC9B,oBAAoB,EAAE,yBAAyB,CAAC;IAChD,gBAAgB,EAAE,MAAM,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,OAAO,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,MAAM,CAAC,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IACjC,MAAM,EAAE,iBAAiB,CAAC;IAC1B,SAAS,EAAE,OAAO,GAAG,MAAM,CAAC;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,UAAU,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,gBAAgB,CAAC;IAC9B,WAAW,EAAE,gBAAgB,CAAC;IAC9B,oBAAoB,EAAE,yBAAyB,CAAC;IAChD,gBAAgB,EAAE,MAAM,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,uBAAuB;IACvC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,OAAO,CAAC,KAAK,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,iBAAiB,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;CACxF;AAED,MAAM,WAAW,oBAAoB;IACpC,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAC;IACnC,OAAO,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzD"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"withAbortableTimeout.d.ts","sourceRoot":"","sources":["../../../../src/exporters/video/withAbortableTimeout.ts"],"names":[],"mappings":"AAEA,wBAAgB,oBAAoB,CAAC,CAAC,EACrC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EACnB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,WAAW,GAAG,SAAS,EAC/B,SAAS,EAAE,MAAM,GACf,OAAO,CAAC,CAAC,CAAC,CA2BZ"}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -26,6 +26,7 @@
|
|
|
26
26
|
* @module textmode.export.js
|
|
27
27
|
*/
|
|
28
28
|
import type { TextmodePlugin } from 'textmode.js';
|
|
29
|
+
import './augmentations';
|
|
29
30
|
import type { TextmodeExportPluginOptions } from './types';
|
|
30
31
|
export type { TextmodeExportAPI, TextmodeExportPluginOptions, ExportOverlayController } from './types';
|
|
31
32
|
export type { ImageExportOptions } from './exporters/image';
|
|
@@ -44,6 +45,8 @@ export type { LayerExportOptions } from './exporters/base';
|
|
|
44
45
|
*
|
|
45
46
|
* @example
|
|
46
47
|
* {@includeCode ../examples/ExportPlugin/init/sketch.js}
|
|
48
|
+
*
|
|
49
|
+
* @see {@link https://code.textmode.art/api/textmode.export.js/variables/ExportPlugin | ExportPlugin API reference}
|
|
47
50
|
*/
|
|
48
51
|
export declare const ExportPlugin: TextmodePlugin;
|
|
49
52
|
/**
|
|
@@ -65,6 +68,8 @@ export declare const ExportPlugin: TextmodePlugin;
|
|
|
65
68
|
*
|
|
66
69
|
* @param options Plugin options
|
|
67
70
|
* @returns A textmode.js plugin instance.
|
|
71
|
+
*
|
|
72
|
+
* @see {@link https://code.textmode.art/api/textmode.export.js/functions/createTextmodeExportPlugin | createTextmodeExportPlugin API reference}
|
|
68
73
|
*/
|
|
69
74
|
export declare const createTextmodeExportPlugin: (options?: TextmodeExportPluginOptions) => TextmodePlugin;
|
|
70
75
|
declare global {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAGH,OAAO,KAAK,EAAE,cAAc,EAAyB,MAAM,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAGH,OAAO,KAAK,EAAE,cAAc,EAAyB,MAAM,aAAa,CAAC;AACzE,OAAO,iBAAiB,CAAC;AASzB,OAAO,KAAK,EAAqB,2BAA2B,EAA2B,MAAM,SAAS,CAAC;AAIvG,YAAY,EAAE,iBAAiB,EAAE,2BAA2B,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AACvG,YAAY,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,YAAY,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACxD,YAAY,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACxD,YAAY,EACX,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,EACd,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,EAChB,aAAa,EACb,iBAAiB,EACjB,4BAA4B,EAC5B,aAAa,EACb,uBAAuB,EACvB,oBAAoB,EACpB,qBAAqB,EACrB,4BAA4B,EAC5B,6BAA6B,GAC7B,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAC3E,YAAY,EACX,gBAAgB,EAChB,kBAAkB,EAClB,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,mBAAmB,EACnB,yBAAyB,EACzB,gBAAgB,EAChB,mBAAmB,GACnB,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAO3D;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,YAAY,EAAE,cAqL1B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,0BAA0B,GAAI,UAAS,2BAAgC,KAAG,cAkBtF,CAAC;AAEF,OAAO,CAAC,MAAM,CAAC;IACd,UAAU,MAAM;QACf,YAAY,CAAC,EAAE,cAAc,CAAC;QAC9B,0BAA0B,CAAC,EAAE,OAAO,0BAA0B,CAAC;KAC/D;CACD"}
|
package/dist/types/types.d.ts
CHANGED
|
@@ -6,6 +6,8 @@ import type { VideoExportOptions } from './exporters/video';
|
|
|
6
6
|
import type { JSONExportOptions, TextmodeDocumentJSON } from './exporters/json';
|
|
7
7
|
/**
|
|
8
8
|
* Controller for managing the export overlay UI visibility at runtime.
|
|
9
|
+
*
|
|
10
|
+
* @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/ExportOverlayController | ExportOverlayController API reference}
|
|
9
11
|
*/
|
|
10
12
|
export interface ExportOverlayController {
|
|
11
13
|
/**
|
|
@@ -15,6 +17,8 @@ export interface ExportOverlayController {
|
|
|
15
17
|
* ```ts
|
|
16
18
|
* t.exportOverlay.show();
|
|
17
19
|
* ```
|
|
20
|
+
*
|
|
21
|
+
* @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/ExportOverlayController/methods/show | ExportOverlayController.show API reference}
|
|
18
22
|
*/
|
|
19
23
|
show(): void;
|
|
20
24
|
/**
|
|
@@ -24,6 +28,8 @@ export interface ExportOverlayController {
|
|
|
24
28
|
* ```ts
|
|
25
29
|
* t.exportOverlay.hide();
|
|
26
30
|
* ```
|
|
31
|
+
*
|
|
32
|
+
* @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/ExportOverlayController/methods/hide | ExportOverlayController.hide API reference}
|
|
27
33
|
*/
|
|
28
34
|
hide(): void;
|
|
29
35
|
/**
|
|
@@ -33,6 +39,8 @@ export interface ExportOverlayController {
|
|
|
33
39
|
* ```ts
|
|
34
40
|
* t.exportOverlay.toggle();
|
|
35
41
|
* ```
|
|
42
|
+
*
|
|
43
|
+
* @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/ExportOverlayController/methods/toggle | ExportOverlayController.toggle API reference}
|
|
36
44
|
*/
|
|
37
45
|
toggle(): void;
|
|
38
46
|
/**
|
|
@@ -42,6 +50,8 @@ export interface ExportOverlayController {
|
|
|
42
50
|
* ```ts
|
|
43
51
|
* const visible = t.exportOverlay.isVisible();
|
|
44
52
|
* ```
|
|
53
|
+
*
|
|
54
|
+
* @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/ExportOverlayController/methods/isVisible | ExportOverlayController.isVisible API reference}
|
|
45
55
|
*/
|
|
46
56
|
isVisible(): boolean;
|
|
47
57
|
}
|
|
@@ -50,10 +60,14 @@ export interface ExportOverlayController {
|
|
|
50
60
|
*
|
|
51
61
|
* @example
|
|
52
62
|
* {@includeCode ../examples/ExportPlugin/layerTargets/sketch.js}
|
|
63
|
+
*
|
|
64
|
+
* @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/TextmodeExportAPI | TextmodeExportAPI API reference}
|
|
53
65
|
*/
|
|
54
66
|
export interface TextmodeExportAPI {
|
|
55
67
|
/**
|
|
56
68
|
* Controller for managing the export overlay UI visibility at runtime.
|
|
69
|
+
*
|
|
70
|
+
* @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/TextmodeExportAPI#exportoverlay | TextmodeExportAPI.exportOverlay API reference}
|
|
57
71
|
*/
|
|
58
72
|
exportOverlay: ExportOverlayController;
|
|
59
73
|
/**
|
|
@@ -65,6 +79,8 @@ export interface TextmodeExportAPI {
|
|
|
65
79
|
* ```ts
|
|
66
80
|
* await t.saveCanvas({ format: 'png', filename: 'frame-001' });
|
|
67
81
|
* ```
|
|
82
|
+
*
|
|
83
|
+
* @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/TextmodeExportAPI/methods/saveCanvas | TextmodeExportAPI.saveCanvas API reference}
|
|
68
84
|
*/
|
|
69
85
|
saveCanvas(options?: ImageExportOptions): Promise<void>;
|
|
70
86
|
/**
|
|
@@ -76,6 +92,8 @@ export interface TextmodeExportAPI {
|
|
|
76
92
|
* ```ts
|
|
77
93
|
* await t.copyCanvas({ format: 'png' });
|
|
78
94
|
* ```
|
|
95
|
+
*
|
|
96
|
+
* @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/TextmodeExportAPI/methods/copyCanvas | TextmodeExportAPI.copyCanvas API reference}
|
|
79
97
|
*/
|
|
80
98
|
copyCanvas(options?: ImageExportOptions): Promise<void>;
|
|
81
99
|
/**
|
|
@@ -87,6 +105,8 @@ export interface TextmodeExportAPI {
|
|
|
87
105
|
* ```ts
|
|
88
106
|
* t.saveSVG({ filename: 'poster', layer: t.layers.base, includeBackgroundRectangles: true });
|
|
89
107
|
* ```
|
|
108
|
+
*
|
|
109
|
+
* @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/TextmodeExportAPI/methods/saveSVG | TextmodeExportAPI.saveSVG API reference}
|
|
90
110
|
*/
|
|
91
111
|
saveSVG(options?: SVGExportOptions): void;
|
|
92
112
|
/**
|
|
@@ -98,6 +118,8 @@ export interface TextmodeExportAPI {
|
|
|
98
118
|
* ```ts
|
|
99
119
|
* t.saveStrings({ filename: 'frame', layer: t.layers.base, preserveTrailingSpaces: true });
|
|
100
120
|
* ```
|
|
121
|
+
*
|
|
122
|
+
* @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/TextmodeExportAPI/methods/saveStrings | TextmodeExportAPI.saveStrings API reference}
|
|
101
123
|
*/
|
|
102
124
|
saveStrings(options?: TXTExportOptions): void;
|
|
103
125
|
/**
|
|
@@ -110,6 +132,8 @@ export interface TextmodeExportAPI {
|
|
|
110
132
|
* ```ts
|
|
111
133
|
* const svg = t.toSVG({ layer: t.layers.base, drawMode: 'stroke', strokeWidth: 1.5 });
|
|
112
134
|
* ```
|
|
135
|
+
*
|
|
136
|
+
* @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/TextmodeExportAPI/methods/toSVG | TextmodeExportAPI.toSVG API reference}
|
|
113
137
|
*/
|
|
114
138
|
toSVG(options?: SVGExportOptions): string;
|
|
115
139
|
/**
|
|
@@ -122,6 +146,8 @@ export interface TextmodeExportAPI {
|
|
|
122
146
|
* ```ts
|
|
123
147
|
* const text = t.toString({ layer: t.layers.base, preserveTrailingSpaces: false });
|
|
124
148
|
* ```
|
|
149
|
+
*
|
|
150
|
+
* @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/TextmodeExportAPI/methods/toString | TextmodeExportAPI.toString API reference}
|
|
125
151
|
*/
|
|
126
152
|
toString(options?: TXTExportOptions): string;
|
|
127
153
|
/**
|
|
@@ -135,6 +161,8 @@ export interface TextmodeExportAPI {
|
|
|
135
161
|
* const layer = t.toJSON({ layer: t.layers.base, colorMode: 'hex', includeMetadata: true });
|
|
136
162
|
* const stack = t.toJSON({ target: 'all' });
|
|
137
163
|
* ```
|
|
164
|
+
*
|
|
165
|
+
* @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/TextmodeExportAPI/methods/toJSON | TextmodeExportAPI.toJSON API reference}
|
|
138
166
|
*/
|
|
139
167
|
toJSON(options?: JSONExportOptions): TextmodeDocumentJSON;
|
|
140
168
|
/**
|
|
@@ -148,6 +176,8 @@ export interface TextmodeExportAPI {
|
|
|
148
176
|
* const json = t.toJSONString({ layer: t.layers.base, pretty: false, colorMode: 'hex' });
|
|
149
177
|
* const stackJson = t.toJSONString({ target: 'all' });
|
|
150
178
|
* ```
|
|
179
|
+
*
|
|
180
|
+
* @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/TextmodeExportAPI/methods/toJSONString | TextmodeExportAPI.toJSONString API reference}
|
|
151
181
|
*/
|
|
152
182
|
toJSONString(options?: JSONExportOptions): string;
|
|
153
183
|
/**
|
|
@@ -160,6 +190,8 @@ export interface TextmodeExportAPI {
|
|
|
160
190
|
* t.saveJSON({ filename: 'frame', layer: t.layers.base, pretty: true });
|
|
161
191
|
* t.saveJSON({ filename: 'stack', target: 'all' });
|
|
162
192
|
* ```
|
|
193
|
+
*
|
|
194
|
+
* @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/TextmodeExportAPI/methods/saveJSON | TextmodeExportAPI.saveJSON API reference}
|
|
163
195
|
*/
|
|
164
196
|
saveJSON(options?: JSONExportOptions): void;
|
|
165
197
|
/**
|
|
@@ -171,6 +203,8 @@ export interface TextmodeExportAPI {
|
|
|
171
203
|
* ```ts
|
|
172
204
|
* await t.saveGIF({ frameCount: 120, frameRate: 30, filename: 'loop' });
|
|
173
205
|
* ```
|
|
206
|
+
*
|
|
207
|
+
* @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/TextmodeExportAPI/methods/saveGIF | TextmodeExportAPI.saveGIF API reference}
|
|
174
208
|
*/
|
|
175
209
|
saveGIF(options?: GIFExportOptions): Promise<void>;
|
|
176
210
|
/**
|
|
@@ -191,6 +225,8 @@ export interface TextmodeExportAPI {
|
|
|
191
225
|
* filename: 'capture',
|
|
192
226
|
* });
|
|
193
227
|
* ```
|
|
228
|
+
*
|
|
229
|
+
* @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/TextmodeExportAPI/methods/saveVideo | TextmodeExportAPI.saveVideo API reference}
|
|
194
230
|
*/
|
|
195
231
|
saveVideo(options?: VideoExportOptions): Promise<void>;
|
|
196
232
|
}
|
|
@@ -200,6 +236,8 @@ export interface TextmodeExportAPI {
|
|
|
200
236
|
* @deprecated This interface is only used by the deprecated `createTextmodeExportPlugin` function.
|
|
201
237
|
* Use {@link ExportPlugin} directly instead, and control overlay visibility at runtime via
|
|
202
238
|
* {@link ExportOverlayController}.
|
|
239
|
+
*
|
|
240
|
+
* @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/TextmodeExportPluginOptions | TextmodeExportPluginOptions API reference}
|
|
203
241
|
*/
|
|
204
242
|
export interface TextmodeExportPluginOptions {
|
|
205
243
|
/**
|
|
@@ -207,6 +245,8 @@ export interface TextmodeExportPluginOptions {
|
|
|
207
245
|
* Defaults to `true`.
|
|
208
246
|
*
|
|
209
247
|
* @deprecated Use runtime overlay controls instead: `textmodifier.exportOverlay.show()` / `.hide()`
|
|
248
|
+
*
|
|
249
|
+
* @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/TextmodeExportPluginOptions#overlay | TextmodeExportPluginOptions.overlay API reference}
|
|
210
250
|
*/
|
|
211
251
|
overlay?: boolean;
|
|
212
252
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,KAAK,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAEhF
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,KAAK,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAEhF;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACvC;;;;;;;;;OASG;IACH,IAAI,IAAI,IAAI,CAAC;IAEb;;;;;;;;;OASG;IACH,IAAI,IAAI,IAAI,CAAC;IAEb;;;;;;;;;OASG;IACH,MAAM,IAAI,IAAI,CAAC;IAEf;;;;;;;;;OASG;IACH,SAAS,IAAI,OAAO,CAAC;CACrB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,iBAAiB;IACjC;;;;OAIG;IACH,aAAa,EAAE,uBAAuB,CAAC;IAEvC;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE1C;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE9C;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,MAAM,CAAC;IAE1C;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,MAAM,CAAC;IAE7C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,oBAAoB,CAAC;IAE1D;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,MAAM,CAAC;IAElD;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAE5C;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACvD;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,2BAA2B;IAC3C;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CAClB"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "textmode.export.js",
|
|
3
|
-
"version": "1.5.
|
|
3
|
+
"version": "1.5.2",
|
|
4
4
|
"description": "Export plugin for textmode.js - Save your creations as images, GIFs, videos, SVG, JSON, and plain text.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/textmode.export.umd.js",
|
|
@@ -26,7 +26,9 @@
|
|
|
26
26
|
"build:types": "tsc",
|
|
27
27
|
"build": "npm run build:bundle && npm run build:types",
|
|
28
28
|
"check": "npm run check:format && npm run lint && npm run lint:md && npm run check:types && npm run check:api-docs && npm run test && npm run build",
|
|
29
|
+
"docs:links:add": "node ./scripts/add-api-doc-links.mjs",
|
|
29
30
|
"check:api-docs": "node ./scripts/check-public-api-docs.mjs",
|
|
31
|
+
"check:examples": "node ./scripts/check-examples.mjs",
|
|
30
32
|
"dev:docs": "typedoc --watch",
|
|
31
33
|
"build:docs": "typedoc",
|
|
32
34
|
"preview": "vite preview",
|