fix: specify stream sink return type (#378)

achingbrain · web-flow · commit e0641fcc2f2a · 2023-04-18T21:43:58.000+02:00
To let tsc handle return types properly and avoid the `unknown` type.
diff --git a/packages/interface-connection/src/index.ts b/packages/interface-connection/src/index.ts
@@ -72,7 +72,7 @@ export interface StreamStat {
  * It may be encrypted and multiplexed depending on the
  * configuration of the nodes.
  */
-export interface Stream extends Duplex<AsyncGenerator<Uint8ArrayList>, Source<Uint8ArrayList | Uint8Array>> {
+export interface Stream extends Duplex<AsyncGenerator<Uint8ArrayList>, Source<Uint8ArrayList | Uint8Array>, Promise<void>> {
   /**
    * Closes the stream for **reading** *and* **writing**.
    *
diff --git a/packages/interface-mocks/package.json b/packages/interface-mocks/package.json
@@ -153,7 +153,7 @@
     "@libp2p/interface-transport": "^3.0.0",
     "@libp2p/interfaces": "^3.0.0",
     "@libp2p/logger": "^2.0.0",
-    "@libp2p/multistream-select": "^3.1.6",
+    "@libp2p/multistream-select": "^3.1.7",
     "@libp2p/peer-collections": "^3.0.1",
     "@libp2p/peer-id": "^2.0.0",
     "@libp2p/peer-id-factory": "^2.0.0",
diff --git a/packages/interface-mocks/src/connection.ts b/packages/interface-mocks/src/connection.ts
@@ -170,7 +170,7 @@ export function mockConnection (maConn: MultiaddrConnection, opts: MockConnectio
   return connection
 }
 
-export function mockStream (stream: Duplex<AsyncGenerator<Uint8ArrayList>, Source<Uint8ArrayList | Uint8Array>>): Stream {
+export function mockStream (stream: Duplex<AsyncGenerator<Uint8ArrayList>, Source<Uint8ArrayList | Uint8Array>, Promise<void>>): Stream {
   return {
     ...stream,
     close: () => {},

Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ export interface StreamStat {`
`72`	`72`	`* It may be encrypted and multiplexed depending on the`
`73`	`73`	`* configuration of the nodes.`
`74`	`74`	`*/`
`75`		`-export interface Stream extends Duplex<AsyncGenerator<Uint8ArrayList>, Source<Uint8ArrayList \| Uint8Array>> {`
	`75`	`+export interface Stream extends Duplex<AsyncGenerator<Uint8ArrayList>, Source<Uint8ArrayList \| Uint8Array>, Promise<void>> {`
`76`	`76`	`/**`
`77`	`77`	`* Closes the stream for reading and writing.`
`78`	`78`	`*`
Original file line number	Diff line number	Diff line change
`@@ -170,7 +170,7 @@ export function mockConnection (maConn: MultiaddrConnection, opts: MockConnectio`
`170`	`170`	`return connection`
`171`	`171`	`}`
`172`	`172`
`173`		`-export function mockStream (stream: Duplex<AsyncGenerator<Uint8ArrayList>, Source<Uint8ArrayList \| Uint8Array>>): Stream {`
	`173`	`+export function mockStream (stream: Duplex<AsyncGenerator<Uint8ArrayList>, Source<Uint8ArrayList \| Uint8Array>, Promise<void>>): Stream {`
`174`	`174`	`return {`
`175`	`175`	`...stream,`
`176`	`176`	`close: () => {},`