Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

deps!: bump it-stream-types from 1.0.5 to 2.0.1 #82

Merged
merged 1 commit into from
Apr 18, 2023
Merged

deps!: bump it-stream-types from 1.0.5 to 2.0.1 #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,12 +169,12 @@
},
"dependencies": {
"get-iterator": "^2.0.0",
"it-stream-types": "^1.0.3"
"it-stream-types": "^2.0.1"
},
"devDependencies": {
"aegir": "^38.1.7",
"delay": "^5.0.0",
"it-drain": "^2.0.1",
"it-pipe": "^2.0.2"
"it-drain": "^3.0.1",
"it-pipe": "^3.0.1"
}
}
10 changes: 6 additions & 4 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,10 @@ export interface Options<T> {
returnOnAbort?: boolean
}

// Wrap an iterator to make it abortable, allow cleanup when aborted via onAbort
export function abortableSource <T> (source: Source<T>, signal: AbortSignal, options?: Options<T>): AsyncGenerator<Awaited<T>, void, unknown> {
/**
* Wrap an iterator to make it abortable, allow cleanup when aborted via onAbort
*/
export function abortableSource <T> (source: Source<T>, signal: AbortSignal, options?: Options<T>): AsyncGenerator<T> {
const opts: Options<T> = options ?? {}
const iterator = getIterator<T>(source)

Expand Down Expand Up @@ -137,11 +139,11 @@ export function abortableSource <T> (source: Source<T>, signal: AbortSignal, opt
return abortable()
}

export function abortableSink <T, R> (sink: Sink<T, R>, signal: AbortSignal, options?: Options<T>): Sink<T, R> {
export function abortableSink <T, R = Promise<void>> (sink: Sink<AsyncIterable<T>, R>, signal: AbortSignal, options?: Options<T>): Sink<AsyncIterable<T>, R> {
return (source: Source<T>) => sink(abortableSource(source, signal, options))
}

export function abortableDuplex <TSource, TSink = TSource, RSink = Promise<void>> (duplex: Duplex<TSource, TSink, RSink>, signal: AbortSignal, options?: Options<TSource>): Duplex<Awaited<TSource>, TSink, RSink> {
export function abortableDuplex <TSource, TSink = TSource, RSink = Promise<void>> (duplex: Duplex<AsyncIterable<TSource>, AsyncIterable<TSink>, RSink>, signal: AbortSignal, options?: Options<TSource>): Duplex<AsyncGenerator<TSource>, AsyncIterable<TSink>, RSink> {
return {
sink: abortableSink(duplex.sink, signal, {
...options,
Expand Down
16 changes: 8 additions & 8 deletions test/index.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { abortableDuplex, abortableSink, abortableSource, abortableTransform } f
import drain from 'it-drain'
import delay from 'delay'
import { pipe } from 'it-pipe'
import type { Sink, Transform, Duplex } from 'it-stream-types'
import type { Sink, Transform, Duplex, Source } from 'it-stream-types'

async function * forever (interval = 1): AsyncGenerator<number, void, unknown> {
// Never ends!
Expand Down Expand Up @@ -142,7 +142,7 @@ describe('abortable-iterator', () => {

it('should abort a sink', async () => {
const controller = new AbortController()
const sink: Sink<number> = async (source) => {
const sink: Sink<AsyncIterable<number>, Promise<void>> = async (source) => {
await drain(source)
}

Expand All @@ -151,14 +151,14 @@ describe('abortable-iterator', () => {

await expect(pipe(
forever(),
abortableSink(sink, controller.signal)
async (source) => { await abortableSink(sink, controller.signal)(source) }
))
.to.eventually.be.rejected.with.property('type', 'aborted')
})

it('should abort a transform', async () => {
const controller = new AbortController()
const transform: Transform<number> = async function * (source) {
const transform: Transform<Source<number>, Source<number>> = async function * (source) {
yield * source
}

Expand All @@ -175,9 +175,9 @@ describe('abortable-iterator', () => {

it('should abort a duplex used as a source', async () => {
const controller = new AbortController()
const duplex: Duplex<number> = {
const duplex: Duplex<AsyncIterable<number>> = {
source: forever(),
sink: drain
sink: async (source) => { await drain(source) }
}

// Abort after 10ms
Expand All @@ -192,7 +192,7 @@ describe('abortable-iterator', () => {

it('should abort a duplex used as a transform', async () => {
const controller = new AbortController()
const duplex: Duplex<number> = {
const duplex: Duplex<AsyncIterable<number>> = {
source: forever(),
sink: drain
}
Expand All @@ -210,7 +210,7 @@ describe('abortable-iterator', () => {

it('should abort a duplex used as a sink', async () => {
const controller = new AbortController()
const duplex: Duplex<number> = {
const duplex: Duplex<AsyncIterable<number>> = {
source: forever(),
sink: drain
}
Expand Down