DefinitelyTyped/types/writable-consumable-stream/consumer.d.ts
Daniel Rose 3b611ed646
Update various socketcluster types to newest versions (#42068)
* Add type definitions for async-stream-emitter, consumable-stream, writable-consumable-stream, stream-demux, ag-channel, ag-simple-broker, ncom, async-iterable-stream

* Upgrade sc-broker to 8.0

* Upgrade socketcluster-client to 15.1

* Rename definition files to match module file names

The files in the module were renamed.

* Move socketcluster-server to v14 folder

In preparation for socketcluster-server v15, since the old version is still used by other type packages.

* Update scc-broker-client to 7.0

* Add current socketcluster-server type definitions

Current version is v15.0

* Move sc-broker-cluster to v6 folder

In preparation for sc-broker-cluster v9, since the old version is still used by other type packages.

* Add current sc-broker-cluster type definitions

Current version is v9.0

* Move sc-channel to v1 folder

In preparation for sc-channel v2, since the old version is still used by other type packages.

* Add current sc-channel type definitions

Current version is v2.0

* Include the relevant sc-broker-cluster type-definitions directly in sc-channel

It can be run using older and newer version of sc-broker-cluster, which have differently versioned dependencies.

* Move sc-channel tests to sc-broker-cluster

In the tests we use sc-broker-cluster. If the tests are in sc-channel, they drag in all dependencies for sc-broker-cluster, including esnext.asynciterable, which we don't want.

* Simplify sc-errors tests

In the tests we used socketcluster-server. That dragged in all of its dependencies, including esnext.asynciterable, which we don't want.

* Move sc-channel to v1 folder

In preparation for sc-channel v2, since the old version is still used by other type packages.
2020-02-05 08:59:09 -08:00

44 lines
971 B
TypeScript

import ConsumableStream = require('consumable-stream');
import WritableConsumableStream = require('.');
declare class Consumer<T> implements ConsumableStream.Consumer<T> {
id: number;
stream: WritableConsumableStream<T>;
currentNode: Consumer.Node<T>;
timeout: number;
constructor(stream: WritableConsumableStream<T>, id: number, startNode: Consumer.Node<T>, timeout: number);
getStats(): Consumer.ConsumerStats;
resetBackpressure(): void;
releaseBackpressure(packet: any): void;
getBackpressure(): number;
write(packet: any): void;
kill(value?: any): void;
next(): Promise<IteratorResult<T>>;
return(): {};
}
export = Consumer;
declare namespace Consumer {
interface ConsumerStats {
id: number;
backpressure: number;
timeout?: number;
}
interface Node<T> {
next: Node<T> | null;
data: {
value: T;
done: boolean;
};
}
}