https://github.com/dex4er/js-promise-duplex

Return promise for duplex stream
https://github.com/dex4er/js-promise-duplex

hacktoberfest

Last synced: about 2 months ago
JSON representation

Return promise for duplex stream

• Host: GitHub
• URL: https://github.com/dex4er/js-promise-duplex
• Owner: dex4er
• License: mit
• Created: 2017-03-12T00:18:45.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-10-23T14:52:02.000Z (2 months ago)
• Last Synced: 2024-10-23T18:18:36.419Z (2 months ago)
• Topics: hacktoberfest
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/promise-duplex
• Size: 114 KB
• Stars: 4
• Watchers: 2
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# promise-duplex

[![GitHub](https://img.shields.io/github/v/release/dex4er/js-promise-duplex?display_name=tag&sort=semver)](https://github.com/dex4er/js-promise-duplex)

[![CI](https://github.com/dex4er/js-promise-duplex/actions/workflows/ci.yaml/badge.svg)](https://github.com/dex4er/js-promise-duplex/actions/workflows/ci.yaml)

[![Trunk Check](https://github.com/dex4er/js-promise-duplex/actions/workflows/trunk.yaml/badge.svg)](https://github.com/dex4er/js-promise-duplex/actions/workflows/trunk.yaml)

[![Coverage Status](https://coveralls.io/repos/github/dex4er/js-promise-duplex/badge.svg)](https://coveralls.io/github/dex4er/js-promise-duplex)

[![npm](https://img.shields.io/npm/v/promise-duplex.svg)](https://www.npmjs.com/package/promise-duplex)

This module allows to convert

[`Duplex`](https://nodejs.org/api/stream.html#stream_class_stream_duplex) stream

into its promisified version, which returns

[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)

object fulfilled when stream's events occurred.

The module combines

[`promise-readable`](https://www.npmjs.com/package/promise-readable) and

[`promise-`](https://www.npmjs.com/package/promise-) in one.

## Requirements

This module requires Node >= 16.

## Installation

```shell

npm install promise-duplex

```

## Usage

```js

import PromiseDuplex from "promise-duplex"

```

### constructor

```js

const promiseDuplex = new PromiseDuplex(stream)

```

`PromiseDuplex` object requires `Duplex` object to work.

_Example:_

```js

import net from "node:net"

import PromiseDuplex from "promise-duplex"

const stream = new net.Socket()

const promiseDuplex = new PromiseDuplex(stream)

```

### stream

```js

const stream = promiseDuplex.stream

```

Original stream object.

_Example:_

```js

console.log(promiseDuplex.stream.localAddress)

```

### read

```js

const chunk = await promiseDuplex.read(chunkSize)

```

Check

[`PromiseReadable.read`](https://www.npmjs.com/package/promise-readable#read)

for details.

### readAll

```js

const content = await promiseDuplex.readAll()

```

Check

[`PromiseReadable.readAll`](https://www.npmjs.com/package/promise-readable#readall)

for details.

### iterate

```js

for await (const chunk of promiseDuplex.iterate(chunkSize)) {

}

```

Check

[`PromiseReadable.iterate`](https://www.npmjs.com/package/promise-readable#iterate)

for details.

### Symbol.asyncIterator

```js

for await (const chunk of promiseDuplex.iterate(chunkSize)) {

}

```

Check

[`PromiseReadable[Symbol.asyncIterator]`](https://www.npmjs.com/package/promise-readable#symbolasynciterator)

for details.

### setEncoding

```js

promiseDuplex = await promiseDuplex.setEncoding(encoding)

```

Check

[`PromiseReadable.setEncoding`](https://www.npmjs.com/package/promise-readable#setencoding)

for details.

### write

```js

await promiseDuplex.write(chunk)

```

Check

[`PromiseWritable.write`](https://www.npmjs.com/package/promise-#write)

for details.

### writeAll

```js

await promiseDuplex.writeAll(content, chunkSize)

```

Check

[`PromiseWritable.writeAll`](https://www.npmjs.com/package/promise-#writeall)

for details.

### end

```js

await promiseDuplex.end()

```

Check

[`PromiseWritable.once`](https://www.npmjs.com/package/promise-#end)

for details.

### once

```js

const result = await promiseDuplex.once(event)

```

Check

[`PromiseReadable.once`](https://www.npmjs.com/package/promise-readable#once)

and

[`PromiseWritable.once`](https://www.npmjs.com/package/promise-#once)

for details.

### destroy

```js

promiseDuplex = promiseDuplex.destroy()

```

This method calls `destroy` method on stream and cleans up all own handlers.

The method returns this object.

## See also

[`PromiseReadable`](https://www.npmjs.com/package/promise-readable),

[`PromiseWritable`](https://www.npmjs.com/package/promise-),

[`PromiseSocket`](https://www.npmjs.com/package/promise-socket),

[`PromisePiping`](https://www.npmjs.com/package/promise-piping).

## License

Copyright (c) 2017-2024 Piotr Roszatycki 

[MIT](https://opensource.org/licenses/MIT)