3.0.15

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@api.global/typedrequest-interfaces",
-  "version": "3.0.12",
+  "version": "3.0.15",
   "private": false,
   "description": "interfaces for making typed requests",
   "main": "dist_ts/index.js",

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@api.global/typedrequest-interfaces',
-  version: '3.0.12',
+  version: '3.0.15',
   description: 'interfaces for making typed requests'
 }

ts/index.ts

@@ -76,6 +76,21 @@ export interface ITag {
 
 export type implementsTag<T, U extends T> = {};
 
+
+// stream stuff
+export interface IVirtualStream<T = ArrayBufferLike> {
+  // Properties
+  side: 'requesting' | 'responding';
+  streamId: string;
+
+  // Methods
+  handleStreamTr(streamTrArg: IStreamRequest): Promise<IStreamRequest>;
+  cleanup(): Promise<void>;
+  sendData(dataArg: T): Promise<void>;
+  fetchData(): Promise<T>;
+  pipeWebStream(webStream: any): void; // Consider defining a more specific type for webStream if possible
+}
+
 export interface IUnifiedStreamDataPackage {
   /**
    * the stream id, so Virtual Streams can talk to each other
@@ -91,12 +106,12 @@ export interface IUnifiedStreamDataPackage {
   /**
    * the main purpose of the data package
    * start: indicates the start of a stream
-   * binaryChunk: indicates a binary chunk of data
-   * object: indicates a json object
+   * chunk: indicates a binary chunk of data
+   * read: indicates the introduction to send data
    * end: indicates the end of a stream
    * feedback: indicates a feedback message
    */
-  mainPurpose: 'start' | 'chunk' | 'object' | 'end' | 'feedback' | 'keepAlive';
+  mainPurpose: 'start' | 'chunk' | 'read' | 'end' | 'feedback' | 'keepAlive';
 
   /**
    * the data package
@@ -118,7 +133,12 @@ export interface IUnifiedStreamDataPackage {
   keepAlive?: boolean;
 
   /**
-   * is there more data scheduled to be sent?
+   * is backpressure detected on the readable side?
+   */
+  backpressure?: boolean;
+
+  /**
+   * does the writable side have more data scheduled to be sent?
    */
   next?: boolean;
 }