Skip to content
This repository has been archived by the owner on Oct 19, 2022. It is now read-only.

fix: make mss abortable #142

Merged
merged 4 commits into from
Dec 21, 2021
Merged

fix: make mss abortable #142

merged 4 commits into from
Dec 21, 2021

Conversation

achingbrain
Copy link
Member

@achingbrain achingbrain commented Dec 21, 2021

Allows passing an options object to dialer.select that can contain an AbortSignal that will throw if the operation is aborted due to a timeout or other criteria.

Also adds types and swaps travis for gh actions.

BREAKING CHANGE: This module now has types

Allows passing an options object to `dialer.select` that can contain
an `AbortSignal` that will throw if the operation is aborted due to
a timeout or other criteria.

Also adds types.
@achingbrain achingbrain requested review from vasco-santos and jacobheun and removed request for vasco-santos December 21, 2021 07:00
Copy link
Contributor

@jacobheun jacobheun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look good 👍, pending fixing CI and minor comment on missing docs update in the readme.

- run: npm install
- run: npm run lint
- run: npm run build
- run: npm run dep-check
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not in the package scripts, was previously run via aegir. CI is failing due to this.

@@ -164,13 +164,14 @@ A new multistream select dialer instance.
const dialer = new MSS.Dialer(duplex)
```

### `dialer.select(protocols)`
### `dialer.select(protocols, [options])`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was added to other API methods, those should get updated in the readme as well.

@achingbrain achingbrain merged commit 2165038 into master Dec 21, 2021
@achingbrain achingbrain deleted the fix/make-mss-abortable branch December 21, 2021 08:49
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants