Skip to content
This repository has been archived by the owner on Jul 16, 2024. It is now read-only.

Commit

Permalink
add documentation for shutdown option
Browse files Browse the repository at this point in the history
  • Loading branch information
fubhy committed Aug 30, 2023
1 parent 8af524a commit a5ef267
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/Sink.ts
Original file line number Diff line number Diff line change
Expand Up @@ -986,6 +986,7 @@ export const fromEffect: <R, E, Z>(effect: Effect.Effect<R, E, Z>) => Sink<R, E,
/**
* Create a sink which publishes each element to the specified hub.
*
* @param shutdown If `true`, the hub will be shutdown after the sink is evaluated (defaults to `false`)
* @since 1.0.0
* @category constructors
*/
Expand All @@ -1011,6 +1012,7 @@ export const fromPush: <R, E, In, L, Z>(
/**
* Create a sink which enqueues each element into the specified queue.
*
* @param shutdown If `true`, the queue will be shutdown after the sink is evaluated (defaults to `false`)
* @since 1.0.0
* @category constructors
*/
Expand Down
4 changes: 4 additions & 0 deletions src/Stream.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1435,6 +1435,7 @@ export const fromChunk: <A>(chunk: Chunk.Chunk<A>) => Stream<never, never, A> =
/**
* Creates a stream from a subscription to a `Hub`.
*
* @param shutdown If `true`, the hub will be shutdown after the stream is evaluated (defaults to `false`)
* @since 1.0.0
* @category constructors
*/
Expand All @@ -1452,6 +1453,7 @@ export const fromChunkHub: {
/**
* Creates a stream from a `Queue` of values.
*
* @param shutdown If `true`, the queue will be shutdown after the stream is evaluated (defaults to `false`)
* @since 1.0.0
* @category constructors
*/
Expand Down Expand Up @@ -1490,6 +1492,7 @@ export const fromEffectOption: <R, E, A>(effect: Effect.Effect<R, Option.Option<
/**
* Creates a stream from a subscription to a `Hub`.
*
* @param shutdown If `true`, the hub will be shutdown after the stream is evaluated (defaults to `false`)
* @since 1.0.0
* @category constructors
*/
Expand Down Expand Up @@ -1546,6 +1549,7 @@ export const fromPull: <R, R2, E, A>(
* Creates a stream from a queue of values
*
* @param maxChunkSize The maximum number of queued elements to put in one chunk in the stream
* @param shutdown If `true`, the queue will be shutdown after the stream is evaluated (defaults to `false`)
* @since 1.0.0
* @category constructors
*/
Expand Down

0 comments on commit a5ef267

Please sign in to comment.