fix(ts): Fixed formatting issues in SmartDuplex class
This commit is contained in:
parent
c8465b82be
commit
a55b2548d7
35
changelog.md
Normal file
35
changelog.md
Normal file
@ -0,0 +1,35 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
## 2024-10-13 - 3.0.45 - fix(ts)
|
||||||
|
Fixed formatting issues in SmartDuplex class
|
||||||
|
|
||||||
|
- Resolved inconsistent spacing in SmartDuplex class methods and constructor.
|
||||||
|
- Ensured consistent formatting in the getWebStreams method.
|
||||||
|
|
||||||
|
## 2024-06-02 - 3.0.39 - smartduplex
|
||||||
|
Add .getWebStreams method
|
||||||
|
|
||||||
|
- Introduced a new `.getWebStreams` method in the smartduplex module, providing compatibility with the web streams API.
|
||||||
|
|
||||||
|
## 2024-03-16 - 3.0.34 - configuration
|
||||||
|
Update project configuration files
|
||||||
|
|
||||||
|
- Updated `tsconfig` for optimization.
|
||||||
|
- Modified `npmextra.json` to set the `githost` attribute.
|
||||||
|
|
||||||
|
## 2023-11-03 - 3.0.0 to 3.0.8 - core
|
||||||
|
Transition to major version 3.x
|
||||||
|
|
||||||
|
- Implemented breaking changes in the core system for better performance and feature set.
|
||||||
|
- Continuous core updates to improve stability and performance across minor version increments.
|
||||||
|
|
||||||
|
## 2023-11-02 - 2.0.4 to 2.0.8 - core
|
||||||
|
Core updates and a major fix
|
||||||
|
|
||||||
|
- Implemented core updates addressing minor bugs and enhancements.
|
||||||
|
- A significant breaking change update transitioning from 2.0.x to 3.0.0.
|
||||||
|
|
||||||
|
## 2022-03-31 - 2.0.0 - core
|
||||||
|
Major esm transition
|
||||||
|
|
||||||
|
- Implemented a breaking change by switching the core to ESM (ECMAScript Module) format for modernized module handling.
|
@ -1,8 +1,8 @@
|
|||||||
/**
|
/**
|
||||||
* autocreated commitinfo by @pushrocks/commitinfo
|
* autocreated commitinfo by @push.rocks/commitinfo
|
||||||
*/
|
*/
|
||||||
export const commitinfo = {
|
export const commitinfo = {
|
||||||
name: '@push.rocks/smartstream',
|
name: '@push.rocks/smartstream',
|
||||||
version: '3.0.44',
|
version: '3.0.45',
|
||||||
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.'
|
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.'
|
||||||
}
|
}
|
||||||
|
@ -34,9 +34,9 @@ export interface ISmartDuplexOptions<TInput, TOutput> extends DuplexOptions {
|
|||||||
* it can push or return chunks (but does not have to) to be written to the readable side of the stream
|
* it can push or return chunks (but does not have to) to be written to the readable side of the stream
|
||||||
*/
|
*/
|
||||||
writeFunction?: IStreamWriteFunction<TInput, TOutput>;
|
writeFunction?: IStreamWriteFunction<TInput, TOutput>;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* a final function that is run at the end of the stream
|
* a final function that is run at the end of the stream
|
||||||
*/
|
*/
|
||||||
finalFunction?: IStreamFinalFunction<TOutput>;
|
finalFunction?: IStreamFinalFunction<TOutput>;
|
||||||
}
|
}
|
||||||
@ -53,21 +53,29 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// INSTANCE
|
// INSTANCE
|
||||||
private backpressuredArray: plugins.lik.BackpressuredArray<TOutput>;
|
private backpressuredArray: plugins.lik.BackpressuredArray<TOutput>; // an array that only takes a defined amount of items
|
||||||
public options: ISmartDuplexOptions<TInput, TOutput>;
|
public options: ISmartDuplexOptions<TInput, TOutput>;
|
||||||
private observableSubscription?: plugins.smartrx.rxjs.Subscription;
|
private observableSubscription?: plugins.smartrx.rxjs.Subscription;
|
||||||
private debugLog(messageArg: string) {
|
private debugLog(messageArg: string) {
|
||||||
|
// optional debug log
|
||||||
if (this.options.debug) {
|
if (this.options.debug) {
|
||||||
console.log(messageArg);
|
console.log(messageArg);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
constructor(optionsArg?: ISmartDuplexOptions<TInput, TOutput>) {
|
constructor(optionsArg?: ISmartDuplexOptions<TInput, TOutput>) {
|
||||||
super(Object.assign({
|
super(
|
||||||
highWaterMark: 1,
|
Object.assign(
|
||||||
}, optionsArg));
|
{
|
||||||
|
highWaterMark: 1,
|
||||||
|
},
|
||||||
|
optionsArg
|
||||||
|
)
|
||||||
|
);
|
||||||
this.options = optionsArg;
|
this.options = optionsArg;
|
||||||
this.backpressuredArray = new plugins.lik.BackpressuredArray<TOutput>(this.options.highWaterMark || 1)
|
this.backpressuredArray = new plugins.lik.BackpressuredArray<TOutput>(
|
||||||
|
this.options.highWaterMark || 1
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
public async _read(size: number): Promise<void> {
|
public async _read(size: number): Promise<void> {
|
||||||
@ -77,14 +85,14 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
|
|||||||
if (this.options.readFunction) {
|
if (this.options.readFunction) {
|
||||||
await this.options.readFunction();
|
await this.options.readFunction();
|
||||||
}
|
}
|
||||||
let canPushMore = true;
|
let canPushMore = true;
|
||||||
while(this.backpressuredArray.data.length > 0 && canPushMore) {
|
while (this.backpressuredArray.data.length > 0 && canPushMore) {
|
||||||
const nextChunk = this.backpressuredArray.shift();
|
const nextChunk = this.backpressuredArray.shift();
|
||||||
canPushMore = this.push(nextChunk);
|
canPushMore = this.push(nextChunk);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
public async backpressuredPush (pushArg: TOutput) {
|
public async backpressuredPush(pushArg: TOutput) {
|
||||||
const canPushMore = this.backpressuredArray.push(pushArg);
|
const canPushMore = this.backpressuredArray.push(pushArg);
|
||||||
if (!canPushMore) {
|
if (!canPushMore) {
|
||||||
this.debugLog(`${this.options.name}: cannot push more`);
|
this.debugLog(`${this.options.name}: cannot push more`);
|
||||||
@ -92,7 +100,7 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
|
|||||||
this.debugLog(`${this.options.name}: can push more again`);
|
this.debugLog(`${this.options.name}: can push more again`);
|
||||||
}
|
}
|
||||||
return canPushMore;
|
return canPushMore;
|
||||||
};
|
}
|
||||||
|
|
||||||
private asyncWritePromiseObjectmap = new plugins.lik.ObjectMap<Promise<any>>();
|
private asyncWritePromiseObjectmap = new plugins.lik.ObjectMap<Promise<any>>();
|
||||||
// Ensure the _write method types the chunk as TInput and encodes TOutput
|
// Ensure the _write method types the chunk as TInput and encodes TOutput
|
||||||
@ -110,7 +118,7 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
|
|||||||
},
|
},
|
||||||
push: async (pushArg: TOutput) => {
|
push: async (pushArg: TOutput) => {
|
||||||
return await this.backpressuredPush(pushArg);
|
return await this.backpressuredPush(pushArg);
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
try {
|
try {
|
||||||
@ -158,7 +166,7 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
|
|||||||
callback();
|
callback();
|
||||||
}
|
}
|
||||||
|
|
||||||
public async getWebStreams(): Promise<{ readable: ReadableStream, writable: WritableStream }> {
|
public async getWebStreams(): Promise<{ readable: ReadableStream; writable: WritableStream }> {
|
||||||
const duplex = this;
|
const duplex = this;
|
||||||
const readable = new ReadableStream({
|
const readable = new ReadableStream({
|
||||||
start(controller) {
|
start(controller) {
|
||||||
@ -168,16 +176,16 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
|
|||||||
controller.enqueue(chunk);
|
controller.enqueue(chunk);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
duplex.on('end', () => {
|
duplex.on('end', () => {
|
||||||
controller.close();
|
controller.close();
|
||||||
});
|
});
|
||||||
},
|
},
|
||||||
cancel(reason) {
|
cancel(reason) {
|
||||||
duplex.destroy(new Error(reason));
|
duplex.destroy(new Error(reason));
|
||||||
}
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
const writable = new WritableStream({
|
const writable = new WritableStream({
|
||||||
write(chunk) {
|
write(chunk) {
|
||||||
return new Promise<void>((resolve, reject) => {
|
return new Promise<void>((resolve, reject) => {
|
||||||
@ -188,7 +196,7 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
|
|||||||
resolve();
|
resolve();
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
if (isBackpressured) {
|
if (isBackpressured) {
|
||||||
duplex.once('drain', resolve);
|
duplex.once('drain', resolve);
|
||||||
}
|
}
|
||||||
@ -201,9 +209,9 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
|
|||||||
},
|
},
|
||||||
abort(reason) {
|
abort(reason) {
|
||||||
duplex.destroy(new Error(reason));
|
duplex.destroy(new Error(reason));
|
||||||
}
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
return { readable, writable };
|
return { readable, writable };
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
/**
|
/**
|
||||||
* autocreated commitinfo by @pushrocks/commitinfo
|
* autocreated commitinfo by @push.rocks/commitinfo
|
||||||
*/
|
*/
|
||||||
export const commitinfo = {
|
export const commitinfo = {
|
||||||
name: '@push.rocks/smartstream',
|
name: '@push.rocks/smartstream',
|
||||||
version: '3.0.44',
|
version: '3.0.45',
|
||||||
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.'
|
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.'
|
||||||
}
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user