@push.rocks/smartstream 3.4.2 → 3.5.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/.smartconfig.json +19 -9
- package/dist_ts/00_commitinfo_data.js +1 -1
- package/dist_ts/smartstream.nodewebhelpers.d.ts +13 -0
- package/dist_ts/smartstream.nodewebhelpers.js +95 -5
- package/dist_ts_web/00_commitinfo_data.js +1 -1
- package/package.json +14 -21
- package/readme.md +31 -2
- package/ts/00_commitinfo_data.ts +1 -1
- package/ts/smartstream.nodewebhelpers.ts +108 -4
- package/ts_web/00_commitinfo_data.ts +1 -1
- package/npmextra.json +0 -45
- package/readme.hints.md +0 -1
- /package/{license → license.md} +0 -0
package/.smartconfig.json
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"@git.zone/cli": {
|
|
3
|
+
"schemaVersion": 2,
|
|
3
4
|
"projectType": "npm",
|
|
4
5
|
"module": {
|
|
5
6
|
"githost": "code.foss.global",
|
|
@@ -11,17 +12,26 @@
|
|
|
11
12
|
"projectDomain": "push.rocks"
|
|
12
13
|
},
|
|
13
14
|
"release": {
|
|
14
|
-
"
|
|
15
|
-
"
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
15
|
+
"targets": {
|
|
16
|
+
"git": {
|
|
17
|
+
"enabled": true,
|
|
18
|
+
"remote": "origin",
|
|
19
|
+
"pushBranch": true,
|
|
20
|
+
"pushTags": true
|
|
21
|
+
},
|
|
22
|
+
"npm": {
|
|
23
|
+
"enabled": true,
|
|
24
|
+
"registries": [
|
|
25
|
+
"https://verdaccio.lossless.digital",
|
|
26
|
+
"https://registry.npmjs.org"
|
|
27
|
+
],
|
|
28
|
+
"accessLevel": "public",
|
|
29
|
+
"alreadyPublished": "success"
|
|
30
|
+
}
|
|
31
|
+
}
|
|
19
32
|
}
|
|
20
33
|
},
|
|
21
34
|
"@git.zone/tsdoc": {
|
|
22
|
-
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
|
23
|
-
},
|
|
24
|
-
"@ship.zone/szci": {
|
|
25
|
-
"npmGlobalTools": []
|
|
35
|
+
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license.md) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
|
26
36
|
}
|
|
27
37
|
}
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export const commitinfo = {
|
|
5
5
|
name: '@push.rocks/smartstream',
|
|
6
|
-
version: '3.
|
|
6
|
+
version: '3.5.0',
|
|
7
7
|
description: 'A library to simplify the creation and manipulation of Node.js streams, providing utilities for handling transform, duplex, and readable/writable streams effectively in TypeScript.'
|
|
8
8
|
};
|
|
9
9
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSx5QkFBeUI7SUFDL0IsT0FBTyxFQUFFLE9BQU87SUFDaEIsV0FBVyxFQUFFLHNMQUFzTDtDQUNwTSxDQUFBIn0=
|
|
@@ -34,3 +34,16 @@ export declare function convertWebWritableToNodeWritable(webWritable: WritableSt
|
|
|
34
34
|
* @returns A Web WritableStream that writes data to the Node.js Writable stream
|
|
35
35
|
*/
|
|
36
36
|
export declare function convertNodeWritableToWebWritable(nodeWritable: plugins.stream.Writable): WritableStream<Uint8Array>;
|
|
37
|
+
/**
|
|
38
|
+
* Converts a Node.js Duplex stream to a Web readable/writable pair that can be
|
|
39
|
+
* passed to `ReadableStream.pipeThrough()`.
|
|
40
|
+
*
|
|
41
|
+
* Both sides share the duplex: the readable side reads with pull-based
|
|
42
|
+
* backpressure and closes on `end`, the writable side resolves each write on the
|
|
43
|
+
* Node.js write callback and ends the duplex on close. Cancelling the readable
|
|
44
|
+
* or aborting the writable destroys the duplex for both sides.
|
|
45
|
+
*
|
|
46
|
+
* @param nodeDuplex - The Node.js Duplex stream to convert
|
|
47
|
+
* @returns A Web readable/writable pair backed by the Node.js Duplex stream
|
|
48
|
+
*/
|
|
49
|
+
export declare function convertNodeDuplexToWebDuplex(nodeDuplex: plugins.stream.Duplex): ReadableWritablePair<Uint8Array, Uint8Array>;
|
|
@@ -66,17 +66,89 @@ export function createWebReadableStreamFromFile(filePath) {
|
|
|
66
66
|
*/
|
|
67
67
|
export function convertWebReadableToNodeReadable(webStream) {
|
|
68
68
|
const reader = webStream.getReader();
|
|
69
|
+
let readInProgress = false;
|
|
70
|
+
let sourceTerminal = false;
|
|
71
|
+
let releaseAttempted = false;
|
|
72
|
+
let cleanupPromise;
|
|
73
|
+
const toError = (errorArg) => errorArg instanceof Error ? errorArg : new Error(String(errorArg));
|
|
74
|
+
const combineErrors = (primaryErrorArg, cleanupErrorsArg) => {
|
|
75
|
+
if (cleanupErrorsArg.length === 0) {
|
|
76
|
+
return primaryErrorArg;
|
|
77
|
+
}
|
|
78
|
+
if (!primaryErrorArg && cleanupErrorsArg.length === 1) {
|
|
79
|
+
return cleanupErrorsArg[0];
|
|
80
|
+
}
|
|
81
|
+
return new AggregateError(primaryErrorArg
|
|
82
|
+
? [primaryErrorArg, ...cleanupErrorsArg]
|
|
83
|
+
: cleanupErrorsArg, 'Web readable cleanup failed');
|
|
84
|
+
};
|
|
85
|
+
const cleanupReader = (cancelActiveSourceArg, cancelReasonArg) => {
|
|
86
|
+
if (cleanupPromise) {
|
|
87
|
+
return cleanupPromise;
|
|
88
|
+
}
|
|
89
|
+
const shouldCancel = cancelActiveSourceArg && !sourceTerminal;
|
|
90
|
+
sourceTerminal = true;
|
|
91
|
+
cleanupPromise = (async () => {
|
|
92
|
+
const cleanupErrors = [];
|
|
93
|
+
if (shouldCancel) {
|
|
94
|
+
try {
|
|
95
|
+
await reader.cancel(cancelReasonArg ?? undefined);
|
|
96
|
+
}
|
|
97
|
+
catch (error) {
|
|
98
|
+
cleanupErrors.push(toError(error));
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
if (!releaseAttempted) {
|
|
102
|
+
releaseAttempted = true;
|
|
103
|
+
try {
|
|
104
|
+
reader.releaseLock();
|
|
105
|
+
}
|
|
106
|
+
catch (error) {
|
|
107
|
+
cleanupErrors.push(toError(error));
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
return cleanupErrors;
|
|
111
|
+
})();
|
|
112
|
+
return cleanupPromise;
|
|
113
|
+
};
|
|
69
114
|
return new plugins.stream.Readable({
|
|
70
115
|
read() {
|
|
71
|
-
|
|
116
|
+
if (readInProgress || sourceTerminal) {
|
|
117
|
+
return;
|
|
118
|
+
}
|
|
119
|
+
readInProgress = true;
|
|
120
|
+
void reader.read().then(({ value, done }) => {
|
|
121
|
+
readInProgress = false;
|
|
122
|
+
if (this.destroyed || sourceTerminal) {
|
|
123
|
+
return;
|
|
124
|
+
}
|
|
72
125
|
if (done) {
|
|
73
|
-
|
|
126
|
+
void cleanupReader(false).then((cleanupErrors) => {
|
|
127
|
+
if (cleanupErrors.length > 0) {
|
|
128
|
+
this.destroy();
|
|
129
|
+
}
|
|
130
|
+
else if (!this.destroyed) {
|
|
131
|
+
this.push(null);
|
|
132
|
+
}
|
|
133
|
+
});
|
|
74
134
|
}
|
|
75
135
|
else {
|
|
76
136
|
this.push(Buffer.from(value));
|
|
77
137
|
}
|
|
78
|
-
}, (
|
|
79
|
-
|
|
138
|
+
}, (error) => {
|
|
139
|
+
readInProgress = false;
|
|
140
|
+
if (this.destroyed || sourceTerminal) {
|
|
141
|
+
return;
|
|
142
|
+
}
|
|
143
|
+
const primaryError = toError(error);
|
|
144
|
+
void cleanupReader(false).then(() => {
|
|
145
|
+
this.destroy(primaryError);
|
|
146
|
+
});
|
|
147
|
+
});
|
|
148
|
+
},
|
|
149
|
+
destroy(error, callback) {
|
|
150
|
+
void cleanupReader(true, error).then((cleanupErrors) => {
|
|
151
|
+
callback(combineErrors(error, cleanupErrors));
|
|
80
152
|
});
|
|
81
153
|
}
|
|
82
154
|
});
|
|
@@ -203,4 +275,22 @@ export function convertNodeWritableToWebWritable(nodeWritable) {
|
|
|
203
275
|
}
|
|
204
276
|
});
|
|
205
277
|
}
|
|
206
|
-
|
|
278
|
+
/**
|
|
279
|
+
* Converts a Node.js Duplex stream to a Web readable/writable pair that can be
|
|
280
|
+
* passed to `ReadableStream.pipeThrough()`.
|
|
281
|
+
*
|
|
282
|
+
* Both sides share the duplex: the readable side reads with pull-based
|
|
283
|
+
* backpressure and closes on `end`, the writable side resolves each write on the
|
|
284
|
+
* Node.js write callback and ends the duplex on close. Cancelling the readable
|
|
285
|
+
* or aborting the writable destroys the duplex for both sides.
|
|
286
|
+
*
|
|
287
|
+
* @param nodeDuplex - The Node.js Duplex stream to convert
|
|
288
|
+
* @returns A Web readable/writable pair backed by the Node.js Duplex stream
|
|
289
|
+
*/
|
|
290
|
+
export function convertNodeDuplexToWebDuplex(nodeDuplex) {
|
|
291
|
+
return {
|
|
292
|
+
readable: convertNodeReadableToWebReadable(nodeDuplex),
|
|
293
|
+
writable: convertNodeWritableToWebWritable(nodeDuplex),
|
|
294
|
+
};
|
|
295
|
+
}
|
|
296
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"smartstream.nodewebhelpers.js","sourceRoot":"","sources":["../ts/smartstream.nodewebhelpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,0BAA0B,CAAC;AAEpD;;;;;GAKG;AACH,MAAM,UAAU,+BAA+B,CAAC,QAAgB;IAC9D,MAAM,UAAU,GAAG,OAAO,CAAC,EAAE,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAEzD,OAAO,IAAI,cAAc,CAAC;QACxB,KAAK,CAAC,UAAU;YACd,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;gBAC7B,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACxB,CAAC,CAAC,CAAC;YAEH,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;gBACxB,UAAU,CAAC,KAAK,EAAE,CAAC;YACrB,CAAC,CAAC,CAAC;YAEH,8CAA8C;YAC9C,UAAU,CAAC,KAAK,EAAE,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,UAAU;YACb,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBAC3C,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;gBAChC,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;oBACnB,UAAU,CAAC,OAAO,CAAC,KAAmB,CAAC,CAAC;oBACxC,OAAO,EAAE,CAAC;oBACV,OAAO;gBACT,CAAC;gBACD,uDAAuD;gBACvD,MAAM,UAAU,GAAG,GAAG,EAAE;oBACtB,OAAO,EAAE,CAAC;oBACV,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;oBAC/B,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;wBAClB,UAAU,CAAC,OAAO,CAAC,IAAkB,CAAC,CAAC;oBACzC,CAAC;oBACD,OAAO,EAAE,CAAC;gBACZ,CAAC,CAAC;gBACF,MAAM,KAAK,GAAG,GAAG,EAAE;oBACjB,OAAO,EAAE,CAAC;oBACV,OAAO,EAAE,CAAC;gBACZ,CAAC,CAAC;gBACF,MAAM,OAAO,GAAG,CAAC,GAAU,EAAE,EAAE;oBAC7B,OAAO,EAAE,CAAC;oBACV,MAAM,CAAC,GAAG,CAAC,CAAC;gBACd,CAAC,CAAC;gBACF,MAAM,OAAO,GAAG,GAAG,EAAE;oBACnB,UAAU,CAAC,cAAc,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;oBAClD,UAAU,CAAC,cAAc,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;oBACxC,UAAU,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAC9C,CAAC,CAAC;gBACF,UAAU,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;gBACxC,UAAU,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gBAC9B,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACpC,CAAC,CAAC,CAAC;QACL,CAAC;QACD,MAAM;YACJ,UAAU,CAAC,OAAO,EAAE,CAAC;QACvB,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gCAAgC,CAAC,SAAqC;IACpF,MAAM,MAAM,GAAG,SAAS,CAAC,SAAS,EAAE,CAAC;IACrC,IAAI,cAAc,GAAG,KAAK,CAAC;IAC3B,IAAI,cAAc,GAAG,KAAK,CAAC;IAC3B,IAAI,gBAAgB,GAAG,KAAK,CAAC;IAC7B,IAAI,cAA4C,CAAC;IAEjD,MAAM,OAAO,GAAG,CAAC,QAAiB,EAAS,EAAE,CAC3C,QAAQ,YAAY,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;IAErE,MAAM,aAAa,GAAG,CACpB,eAA6B,EAC7B,gBAAyB,EACX,EAAE;QAChB,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClC,OAAO,eAAe,CAAC;QACzB,CAAC;QACD,IAAI,CAAC,eAAe,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtD,OAAO,gBAAgB,CAAC,CAAC,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,IAAI,cAAc,CACvB,eAAe;YACb,CAAC,CAAC,CAAC,eAAe,EAAE,GAAG,gBAAgB,CAAC;YACxC,CAAC,CAAC,gBAAgB,EACpB,6BAA6B,CAC9B,CAAC;IACJ,CAAC,CAAC;IAEF,MAAM,aAAa,GAAG,CACpB,qBAA8B,EAC9B,eAA8B,EACZ,EAAE;QACpB,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,cAAc,CAAC;QACxB,CAAC;QAED,MAAM,YAAY,GAAG,qBAAqB,IAAI,CAAC,cAAc,CAAC;QAC9D,cAAc,GAAG,IAAI,CAAC;QACtB,cAAc,GAAG,CAAC,KAAK,IAAI,EAAE;YAC3B,MAAM,aAAa,GAAY,EAAE,CAAC;YAClC,IAAI,YAAY,EAAE,CAAC;gBACjB,IAAI,CAAC;oBACH,MAAM,MAAM,CAAC,MAAM,CAAC,eAAe,IAAI,SAAS,CAAC,CAAC;gBACpD,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrC,CAAC;YACH,CAAC;YACD,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACtB,gBAAgB,GAAG,IAAI,CAAC;gBACxB,IAAI,CAAC;oBACH,MAAM,CAAC,WAAW,EAAE,CAAC;gBACvB,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrC,CAAC;YACH,CAAC;YACD,OAAO,aAAa,CAAC;QACvB,CAAC,CAAC,EAAE,CAAC;QACL,OAAO,cAAc,CAAC;IACxB,CAAC,CAAC;IAEF,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC;QACjC,IAAI;YACF,IAAI,cAAc,IAAI,cAAc,EAAE,CAAC;gBACrC,OAAO;YACT,CAAC;YACD,cAAc,GAAG,IAAI,CAAC;YACtB,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC,IAAI,CACrB,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE;gBAClB,cAAc,GAAG,KAAK,CAAC;gBACvB,IAAI,IAAI,CAAC,SAAS,IAAI,cAAc,EAAE,CAAC;oBACrC,OAAO;gBACT,CAAC;gBACD,IAAI,IAAI,EAAE,CAAC;oBACT,KAAK,aAAa,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE;wBAC/C,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;4BAC7B,IAAI,CAAC,OAAO,EAAE,CAAC;wBACjB,CAAC;6BAAM,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;4BAC3B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;wBAClB,CAAC;oBACH,CAAC,CAAC,CAAC;gBACL,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;gBAChC,CAAC;YACH,CAAC,EACD,CAAC,KAAK,EAAE,EAAE;gBACR,cAAc,GAAG,KAAK,CAAC;gBACvB,IAAI,IAAI,CAAC,SAAS,IAAI,cAAc,EAAE,CAAC;oBACrC,OAAO;gBACT,CAAC;gBACD,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;gBACpC,KAAK,aAAa,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;oBAClC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;gBAC7B,CAAC,CAAC,CAAC;YACL,CAAC,CACF,CAAC;QACJ,CAAC;QACD,OAAO,CAAC,KAAK,EAAE,QAAQ;YACrB,KAAK,aAAa,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE;gBACrD,QAAQ,CAAC,aAAa,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC;YAChD,CAAC,CAAC,CAAC;QACL,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gCAAgC,CAAC,UAAmC;IAClF,OAAO,IAAI,cAAc,CAAC;QACxB,KAAK,CAAC,UAAU;YACd,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;gBAC7B,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACxB,CAAC,CAAC,CAAC;YAEH,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;gBACxB,UAAU,CAAC,KAAK,EAAE,CAAC;YACrB,CAAC,CAAC,CAAC;YAEH,8CAA8C;YAC9C,UAAU,CAAC,KAAK,EAAE,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,UAAU;YACb,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBAC3C,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;gBAChC,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;oBACnB,UAAU,CAAC,OAAO,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;oBAC1C,OAAO,EAAE,CAAC;oBACV,OAAO;gBACT,CAAC;gBACD,uDAAuD;gBACvD,MAAM,UAAU,GAAG,GAAG,EAAE;oBACtB,OAAO,EAAE,CAAC;oBACV,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;oBAC/B,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;wBAClB,UAAU,CAAC,OAAO,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;oBAC3C,CAAC;oBACD,OAAO,EAAE,CAAC;gBACZ,CAAC,CAAC;gBACF,MAAM,KAAK,GAAG,GAAG,EAAE;oBACjB,OAAO,EAAE,CAAC;oBACV,OAAO,EAAE,CAAC;gBACZ,CAAC,CAAC;gBACF,MAAM,OAAO,GAAG,CAAC,GAAU,EAAE,EAAE;oBAC7B,OAAO,EAAE,CAAC;oBACV,MAAM,CAAC,GAAG,CAAC,CAAC;gBACd,CAAC,CAAC;gBACF,MAAM,OAAO,GAAG,GAAG,EAAE;oBACnB,UAAU,CAAC,cAAc,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;oBAClD,UAAU,CAAC,cAAc,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;oBACxC,UAAU,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAC9C,CAAC,CAAC;gBACF,UAAU,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;gBACxC,UAAU,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gBAC9B,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACpC,CAAC,CAAC,CAAC;QACL,CAAC;QACD,MAAM;YACJ,UAAU,CAAC,OAAO,EAAE,CAAC;QACvB,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gCAAgC,CAAC,WAAuC;IACtF,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,EAAE,CAAC;IAEvC,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC;QACjC,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ;YAC7B,MAAM,CAAC,KAAK,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CACtC,GAAG,EAAE,CAAC,QAAQ,EAAE,EAChB,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CACvB,CAAC;QACJ,CAAC;QACD,KAAK,CAAC,QAAQ;YACZ,MAAM,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACxD,CAAC;QACD,OAAO,CAAC,GAAG,EAAE,QAAQ;YACnB,IAAI,GAAG,EAAE,CAAC;gBACR,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;YACzE,CAAC;iBAAM,CAAC;gBACN,wCAAwC;gBACxC,MAAM,CAAC,WAAW,EAAE,CAAC;gBACrB,QAAQ,CAAC,IAAI,CAAC,CAAC;YACjB,CAAC;QACH,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gCAAgC,CAAC,YAAqC;IACpF,OAAO,IAAI,cAAc,CAAC;QACxB,KAAK,CAAC,KAAK;YACT,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACrC,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE;oBAC7C,IAAI,GAAG,EAAE,CAAC;wBACR,MAAM,CAAC,GAAG,CAAC,CAAC;oBACd,CAAC;yBAAM,CAAC;wBACN,OAAO,EAAE,CAAC;oBACZ,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;QACD,KAAK;YACH,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACrC,YAAY,CAAC,GAAG,CAAC,CAAC,GAAiB,EAAE,EAAE;oBACrC,IAAI,GAAG,EAAE,CAAC;wBACR,MAAM,CAAC,GAAG,CAAC,CAAC;oBACd,CAAC;yBAAM,CAAC;wBACN,OAAO,EAAE,CAAC;oBACZ,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;QACD,KAAK,CAAC,MAAM;YACV,YAAY,CAAC,OAAO,CAAC,MAAM,YAAY,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACrF,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,4BAA4B,CAC1C,UAAiC;IAEjC,OAAO;QACL,QAAQ,EAAE,gCAAgC,CAAC,UAAU,CAAC;QACtD,QAAQ,EAAE,gCAAgC,CAAC,UAAU,CAAC;KACvD,CAAC;AACJ,CAAC"}
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export const commitinfo = {
|
|
5
5
|
name: '@push.rocks/smartstream',
|
|
6
|
-
version: '3.
|
|
6
|
+
version: '3.5.0',
|
|
7
7
|
description: 'A library to simplify the creation and manipulation of Node.js streams, providing utilities for handling transform, duplex, and readable/writable streams effectively in TypeScript.'
|
|
8
8
|
};
|
|
9
9
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHNfd2ViLzAwX2NvbW1pdGluZm9fZGF0YS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQTs7R0FFRztBQUNILE1BQU0sQ0FBQyxNQUFNLFVBQVUsR0FBRztJQUN4QixJQUFJLEVBQUUseUJBQXlCO0lBQy9CLE9BQU8sRUFBRSxPQUFPO0lBQ2hCLFdBQVcsRUFBRSxzTEFBc0w7Q0FDcE0sQ0FBQSJ9
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@push.rocks/smartstream",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.5.0",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "A library to simplify the creation and manipulation of Node.js streams, providing utilities for handling transform, duplex, and readable/writable streams effectively in TypeScript.",
|
|
6
6
|
"type": "module",
|
|
@@ -8,10 +8,6 @@
|
|
|
8
8
|
".": "./dist_ts/index.js",
|
|
9
9
|
"./web": "./dist_ts_web/index.js"
|
|
10
10
|
},
|
|
11
|
-
"scripts": {
|
|
12
|
-
"test": "(tstest test/ --verbose --logfile --timeout 60)",
|
|
13
|
-
"build": "(tsbuild tsfolders)"
|
|
14
|
-
},
|
|
15
11
|
"repository": {
|
|
16
12
|
"type": "git",
|
|
17
13
|
"url": "https://code.foss.global/push.rocks/smartstream.git"
|
|
@@ -23,16 +19,16 @@
|
|
|
23
19
|
},
|
|
24
20
|
"homepage": "https://code.foss.global/push.rocks/smartstream",
|
|
25
21
|
"devDependencies": {
|
|
26
|
-
"@git.zone/tsbuild": "^
|
|
27
|
-
"@git.zone/tsrun": "^
|
|
28
|
-
"@git.zone/tstest": "^
|
|
29
|
-
"@types/node": "^
|
|
22
|
+
"@git.zone/tsbuild": "^5.1.0",
|
|
23
|
+
"@git.zone/tsrun": "^3.0.2",
|
|
24
|
+
"@git.zone/tstest": "^6.3.2",
|
|
25
|
+
"@types/node": "^26.6.2"
|
|
30
26
|
},
|
|
31
27
|
"dependencies": {
|
|
32
28
|
"@push.rocks/lik": "^6.4.1",
|
|
33
|
-
"@push.rocks/smartenv": "^6.
|
|
34
|
-
"@push.rocks/smartpromise": "^4.2.
|
|
35
|
-
"@push.rocks/smartrx": "^3.0.
|
|
29
|
+
"@push.rocks/smartenv": "^6.1.0",
|
|
30
|
+
"@push.rocks/smartpromise": "^4.2.5",
|
|
31
|
+
"@push.rocks/smartrx": "^3.0.12"
|
|
36
32
|
},
|
|
37
33
|
"browserslist": [
|
|
38
34
|
"last 1 chrome versions"
|
|
@@ -47,15 +43,9 @@
|
|
|
47
43
|
"assets/**/*",
|
|
48
44
|
"cli.js",
|
|
49
45
|
".smartconfig.json",
|
|
50
|
-
"license",
|
|
51
|
-
"npmextra.json",
|
|
46
|
+
"license.md",
|
|
52
47
|
"readme.md"
|
|
53
48
|
],
|
|
54
|
-
"pnpm": {
|
|
55
|
-
"overrides": {
|
|
56
|
-
"agentkeepalive": "^4.6.0"
|
|
57
|
-
}
|
|
58
|
-
},
|
|
59
49
|
"keywords": [
|
|
60
50
|
"stream",
|
|
61
51
|
"node.js",
|
|
@@ -75,5 +65,8 @@
|
|
|
75
65
|
"stream utilities",
|
|
76
66
|
"esm"
|
|
77
67
|
],
|
|
78
|
-
"
|
|
79
|
-
|
|
68
|
+
"scripts": {
|
|
69
|
+
"test": "(tstest test/ --verbose --logfile --timeout 60)",
|
|
70
|
+
"build": "(tsbuild tsfolders)"
|
|
71
|
+
}
|
|
72
|
+
}
|
package/readme.md
CHANGED
|
@@ -399,7 +399,7 @@ const stream = new WebDuplexStream<string, string>({
|
|
|
399
399
|
|
|
400
400
|
### 🔀 Node ↔ Web Stream Converters
|
|
401
401
|
|
|
402
|
-
The `nodewebhelpers` namespace provides bidirectional converters between Node.js and Web Streams with proper backpressure
|
|
402
|
+
The `nodewebhelpers` namespace provides bidirectional converters between Node.js and Web Streams with proper backpressure and lifecycle ownership. Destroying a Node readable created by `convertWebReadableToNodeReadable()` awaits cancellation of its active Web reader and releases the reader lock; normal EOF and source errors also release the lock. Sole source or cleanup errors retain their identity, while concurrent primary and cleanup failures are reported as an `AggregateError` with the primary error first. Read completions that settle after teardown are discarded.
|
|
403
403
|
|
|
404
404
|
```typescript
|
|
405
405
|
import { nodewebhelpers } from '@push.rocks/smartstream';
|
|
@@ -412,6 +412,7 @@ import { nodewebhelpers } from '@push.rocks/smartstream';
|
|
|
412
412
|
| `convertNodeReadableToWebReadable(nodeStream)` | Node.js `Readable` | Web `ReadableStream` |
|
|
413
413
|
| `convertWebWritableToNodeWritable(webWritable)` | Web `WritableStream` | Node.js `Writable` |
|
|
414
414
|
| `convertNodeWritableToWebWritable(nodeWritable)` | Node.js `Writable` | Web `WritableStream` |
|
|
415
|
+
| `convertNodeDuplexToWebDuplex(nodeDuplex)` | Node.js `Duplex` | Web `{ readable, writable }` pair (usable with `pipeThrough()`) |
|
|
415
416
|
|
|
416
417
|
#### Example: Serve a File as a Web ReadableStream
|
|
417
418
|
|
|
@@ -439,6 +440,19 @@ const nodeReadable2 = nodewebhelpers.convertWebReadableToNodeReadable(webReadabl
|
|
|
439
440
|
nodeReadable2.pipe(fs.createWriteStream('./copy.bin'));
|
|
440
441
|
```
|
|
441
442
|
|
|
443
|
+
#### Example: Use a Node.js Duplex in a Web Pipeline
|
|
444
|
+
|
|
445
|
+
`convertNodeDuplexToWebDuplex()` returns a `ReadableWritablePair<Uint8Array, Uint8Array>` whose sides share the duplex. Closing the writable ends the duplex; cancelling the readable or aborting the writable destroys it for both sides.
|
|
446
|
+
|
|
447
|
+
```typescript
|
|
448
|
+
import zlib from 'zlib';
|
|
449
|
+
import { nodewebhelpers } from '@push.rocks/smartstream';
|
|
450
|
+
|
|
451
|
+
const gzipped = webReadable.pipeThrough(
|
|
452
|
+
nodewebhelpers.convertNodeDuplexToWebDuplex(zlib.createGzip()),
|
|
453
|
+
);
|
|
454
|
+
```
|
|
455
|
+
|
|
442
456
|
#### Example: Round-Trip Conversion
|
|
443
457
|
|
|
444
458
|
```typescript
|
|
@@ -572,6 +586,7 @@ console.log('Error extraction complete');
|
|
|
572
586
|
| `convertNodeReadableToWebReadable(ns)` | Node.js Readable → Web ReadableStream (pull-based backpressure) |
|
|
573
587
|
| `convertWebWritableToNodeWritable(ws)` | Web WritableStream → Node.js Writable |
|
|
574
588
|
| `convertNodeWritableToWebWritable(nw)` | Node.js Writable → Web WritableStream |
|
|
589
|
+
| `convertNodeDuplexToWebDuplex(nd)` | Node.js Duplex → Web `{ readable, writable }` pair |
|
|
575
590
|
|
|
576
591
|
#### Utility Functions
|
|
577
592
|
|
|
@@ -580,9 +595,23 @@ console.log('Error extraction complete');
|
|
|
580
595
|
| `createTransformFunction(fn, opts?)` | Create a SmartDuplex from an async mapping function |
|
|
581
596
|
| `createPassThrough()` | Create an object-mode passthrough stream |
|
|
582
597
|
|
|
598
|
+
## Migration from @push.rocks/webstream
|
|
599
|
+
|
|
600
|
+
`@push.rocks/webstream` is deprecated; its Web Streams surface lives in this package.
|
|
601
|
+
|
|
602
|
+
| `@push.rocks/webstream` | `@push.rocks/smartstream` |
|
|
603
|
+
|---|---|
|
|
604
|
+
| `import { WebDuplexStream } from '@push.rocks/webstream'` | `import { WebDuplexStream } from '@push.rocks/smartstream/web'` |
|
|
605
|
+
| `WebDuplexStream.fromUInt8Array(bytes)` | `WebDuplexStream.fromUInt8Array(bytes)` (unchanged) |
|
|
606
|
+
| `new WebDuplexStream({ writeFunction, finalFunction })` | unchanged; without a `writeFunction` chunks now pass through instead of erroring |
|
|
607
|
+
| `new WebDuplexStream({ readFunction })` + `stream.getCustomReadableStream()` | `new WebDuplexStream({ readFunction })` + `stream.readable`; the `readFunction` starts automatically, `await tools.write(chunk)` feeds the stream and `tools.done()` closes it |
|
|
608
|
+
| `convertDuplexToWebStream(duplex)` | `nodewebhelpers.convertNodeDuplexToWebDuplex(duplex)` from `@push.rocks/smartstream` (Node.js `Duplex`, `Uint8Array` chunks) |
|
|
609
|
+
|
|
610
|
+
`convertNodeDuplexToWebDuplex()` carries `Uint8Array` chunks only, like every `nodewebhelpers` converter; object-mode or string-encoded duplexes that `convertDuplexToWebStream()` passed through unchanged have no equivalent here.
|
|
611
|
+
|
|
583
612
|
## License and Legal Information
|
|
584
613
|
|
|
585
|
-
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [
|
|
614
|
+
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [license](./license.md) file.
|
|
586
615
|
|
|
587
616
|
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
|
588
617
|
|
package/ts/00_commitinfo_data.ts
CHANGED
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export const commitinfo = {
|
|
5
5
|
name: '@push.rocks/smartstream',
|
|
6
|
-
version: '3.
|
|
6
|
+
version: '3.5.0',
|
|
7
7
|
description: 'A library to simplify the creation and manipulation of Node.js streams, providing utilities for handling transform, duplex, and readable/writable streams effectively in TypeScript.'
|
|
8
8
|
}
|
|
@@ -71,21 +71,104 @@ export function createWebReadableStreamFromFile(filePath: string): ReadableStrea
|
|
|
71
71
|
*/
|
|
72
72
|
export function convertWebReadableToNodeReadable(webStream: ReadableStream<Uint8Array>): plugins.stream.Readable {
|
|
73
73
|
const reader = webStream.getReader();
|
|
74
|
+
let readInProgress = false;
|
|
75
|
+
let sourceTerminal = false;
|
|
76
|
+
let releaseAttempted = false;
|
|
77
|
+
let cleanupPromise: Promise<Error[]> | undefined;
|
|
78
|
+
|
|
79
|
+
const toError = (errorArg: unknown): Error =>
|
|
80
|
+
errorArg instanceof Error ? errorArg : new Error(String(errorArg));
|
|
81
|
+
|
|
82
|
+
const combineErrors = (
|
|
83
|
+
primaryErrorArg: Error | null,
|
|
84
|
+
cleanupErrorsArg: Error[],
|
|
85
|
+
): Error | null => {
|
|
86
|
+
if (cleanupErrorsArg.length === 0) {
|
|
87
|
+
return primaryErrorArg;
|
|
88
|
+
}
|
|
89
|
+
if (!primaryErrorArg && cleanupErrorsArg.length === 1) {
|
|
90
|
+
return cleanupErrorsArg[0];
|
|
91
|
+
}
|
|
92
|
+
return new AggregateError(
|
|
93
|
+
primaryErrorArg
|
|
94
|
+
? [primaryErrorArg, ...cleanupErrorsArg]
|
|
95
|
+
: cleanupErrorsArg,
|
|
96
|
+
'Web readable cleanup failed',
|
|
97
|
+
);
|
|
98
|
+
};
|
|
99
|
+
|
|
100
|
+
const cleanupReader = (
|
|
101
|
+
cancelActiveSourceArg: boolean,
|
|
102
|
+
cancelReasonArg?: Error | null,
|
|
103
|
+
): Promise<Error[]> => {
|
|
104
|
+
if (cleanupPromise) {
|
|
105
|
+
return cleanupPromise;
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
const shouldCancel = cancelActiveSourceArg && !sourceTerminal;
|
|
109
|
+
sourceTerminal = true;
|
|
110
|
+
cleanupPromise = (async () => {
|
|
111
|
+
const cleanupErrors: Error[] = [];
|
|
112
|
+
if (shouldCancel) {
|
|
113
|
+
try {
|
|
114
|
+
await reader.cancel(cancelReasonArg ?? undefined);
|
|
115
|
+
} catch (error) {
|
|
116
|
+
cleanupErrors.push(toError(error));
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
if (!releaseAttempted) {
|
|
120
|
+
releaseAttempted = true;
|
|
121
|
+
try {
|
|
122
|
+
reader.releaseLock();
|
|
123
|
+
} catch (error) {
|
|
124
|
+
cleanupErrors.push(toError(error));
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
return cleanupErrors;
|
|
128
|
+
})();
|
|
129
|
+
return cleanupPromise;
|
|
130
|
+
};
|
|
74
131
|
|
|
75
132
|
return new plugins.stream.Readable({
|
|
76
133
|
read() {
|
|
77
|
-
|
|
134
|
+
if (readInProgress || sourceTerminal) {
|
|
135
|
+
return;
|
|
136
|
+
}
|
|
137
|
+
readInProgress = true;
|
|
138
|
+
void reader.read().then(
|
|
78
139
|
({ value, done }) => {
|
|
140
|
+
readInProgress = false;
|
|
141
|
+
if (this.destroyed || sourceTerminal) {
|
|
142
|
+
return;
|
|
143
|
+
}
|
|
79
144
|
if (done) {
|
|
80
|
-
|
|
145
|
+
void cleanupReader(false).then((cleanupErrors) => {
|
|
146
|
+
if (cleanupErrors.length > 0) {
|
|
147
|
+
this.destroy();
|
|
148
|
+
} else if (!this.destroyed) {
|
|
149
|
+
this.push(null);
|
|
150
|
+
}
|
|
151
|
+
});
|
|
81
152
|
} else {
|
|
82
153
|
this.push(Buffer.from(value));
|
|
83
154
|
}
|
|
84
155
|
},
|
|
85
|
-
(
|
|
86
|
-
|
|
156
|
+
(error) => {
|
|
157
|
+
readInProgress = false;
|
|
158
|
+
if (this.destroyed || sourceTerminal) {
|
|
159
|
+
return;
|
|
160
|
+
}
|
|
161
|
+
const primaryError = toError(error);
|
|
162
|
+
void cleanupReader(false).then(() => {
|
|
163
|
+
this.destroy(primaryError);
|
|
164
|
+
});
|
|
87
165
|
}
|
|
88
166
|
);
|
|
167
|
+
},
|
|
168
|
+
destroy(error, callback) {
|
|
169
|
+
void cleanupReader(true, error).then((cleanupErrors) => {
|
|
170
|
+
callback(combineErrors(error, cleanupErrors));
|
|
171
|
+
});
|
|
89
172
|
}
|
|
90
173
|
});
|
|
91
174
|
}
|
|
@@ -217,3 +300,24 @@ export function convertNodeWritableToWebWritable(nodeWritable: plugins.stream.Wr
|
|
|
217
300
|
}
|
|
218
301
|
});
|
|
219
302
|
}
|
|
303
|
+
|
|
304
|
+
/**
|
|
305
|
+
* Converts a Node.js Duplex stream to a Web readable/writable pair that can be
|
|
306
|
+
* passed to `ReadableStream.pipeThrough()`.
|
|
307
|
+
*
|
|
308
|
+
* Both sides share the duplex: the readable side reads with pull-based
|
|
309
|
+
* backpressure and closes on `end`, the writable side resolves each write on the
|
|
310
|
+
* Node.js write callback and ends the duplex on close. Cancelling the readable
|
|
311
|
+
* or aborting the writable destroys the duplex for both sides.
|
|
312
|
+
*
|
|
313
|
+
* @param nodeDuplex - The Node.js Duplex stream to convert
|
|
314
|
+
* @returns A Web readable/writable pair backed by the Node.js Duplex stream
|
|
315
|
+
*/
|
|
316
|
+
export function convertNodeDuplexToWebDuplex(
|
|
317
|
+
nodeDuplex: plugins.stream.Duplex,
|
|
318
|
+
): ReadableWritablePair<Uint8Array, Uint8Array> {
|
|
319
|
+
return {
|
|
320
|
+
readable: convertNodeReadableToWebReadable(nodeDuplex),
|
|
321
|
+
writable: convertNodeWritableToWebWritable(nodeDuplex),
|
|
322
|
+
};
|
|
323
|
+
}
|
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export const commitinfo = {
|
|
5
5
|
name: '@push.rocks/smartstream',
|
|
6
|
-
version: '3.
|
|
6
|
+
version: '3.5.0',
|
|
7
7
|
description: 'A library to simplify the creation and manipulation of Node.js streams, providing utilities for handling transform, duplex, and readable/writable streams effectively in TypeScript.'
|
|
8
8
|
}
|
package/npmextra.json
DELETED
|
@@ -1,45 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"@git.zone/cli": {
|
|
3
|
-
"projectType": "npm",
|
|
4
|
-
"module": {
|
|
5
|
-
"githost": "code.foss.global",
|
|
6
|
-
"gitscope": "push.rocks",
|
|
7
|
-
"gitrepo": "smartstream",
|
|
8
|
-
"description": "A library to simplify the creation and manipulation of Node.js streams, providing utilities for handling transform, duplex, and readable/writable streams effectively in TypeScript.",
|
|
9
|
-
"npmPackagename": "@push.rocks/smartstream",
|
|
10
|
-
"license": "MIT",
|
|
11
|
-
"keywords": [
|
|
12
|
-
"stream",
|
|
13
|
-
"node.js",
|
|
14
|
-
"typescript",
|
|
15
|
-
"stream manipulation",
|
|
16
|
-
"data processing",
|
|
17
|
-
"pipeline",
|
|
18
|
-
"async transformation",
|
|
19
|
-
"event handling",
|
|
20
|
-
"backpressure",
|
|
21
|
-
"readable stream",
|
|
22
|
-
"writable stream",
|
|
23
|
-
"duplex stream",
|
|
24
|
-
"transform stream",
|
|
25
|
-
"file streaming",
|
|
26
|
-
"buffer",
|
|
27
|
-
"stream utilities",
|
|
28
|
-
"esm"
|
|
29
|
-
]
|
|
30
|
-
},
|
|
31
|
-
"release": {
|
|
32
|
-
"registries": [
|
|
33
|
-
"https://verdaccio.lossless.digital",
|
|
34
|
-
"https://registry.npmjs.org"
|
|
35
|
-
],
|
|
36
|
-
"accessLevel": "public"
|
|
37
|
-
}
|
|
38
|
-
},
|
|
39
|
-
"@git.zone/tsdoc": {
|
|
40
|
-
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
|
41
|
-
},
|
|
42
|
-
"@ship.zone/szci": {
|
|
43
|
-
"npmGlobalTools": []
|
|
44
|
-
}
|
|
45
|
-
}
|
package/readme.hints.md
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
- make sure to respect backpressure handling.
|
/package/{license → license.md}
RENAMED
|
File without changes
|