Skip to content

Commit

Permalink
Add warning to toReadable() raw variant about atom types
Browse files Browse the repository at this point in the history
  • Loading branch information
giraugh committed May 20, 2024
1 parent b8a8ed7 commit e70811c
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/stream/consumption.ts
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,9 @@ export class StreamConsumption<T, E> extends StreamBase {
toReadable(kind: "raw" | "object", options?: { atoms?: boolean }): Readable;

/**
* Produce a readable node stream with the raw values from the stream.
* Produce a readable node stream with the raw values from the stream
* @note the stream must only contain atoms of type `string` or `Buffer`. If not, a
* stream error will be emitted.
*
* @param options.single - Whether to emit only the first atom
*
Expand Down

0 comments on commit e70811c

Please sign in to comment.