Repository navigation
feat: expose stdin EOF state - #57
Merged
Merged
Conversation
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Background
Issue #43 reports that callers cannot reliably stop a formatted stdin loop at end-of-file. For formats containing multiple conversions,
scanf()returns an array even when every conversion producesnull. Arrays are truthy in JavaScript, so a loop that uses the returned array as its condition continues after stdin has ended. The same all-null result can also come from a format mismatch, so inspecting values alone is not a reliable EOF test.Related to #43.
What changed
scanf.isEOF()as an opt-in, read-only status query.readSync()boundary, including both zero-byte reads and the Windows-styleEOFerror path.scanf()argument and return-value behavior unchanged.sscanf()does not expose stale stdin EOF state.scanf.isEOF().Example
EOF becomes observable only after a read attempts to go past the available input, matching normal stream semantics. An empty line and a format mismatch do not set the EOF state.
Compatibility
This is an additive API. Existing callers receive the same values from
scanf()andsscanf(), and no existing parameters are overloaded. The implementation uses ES5-compatible syntax and has been exercised on Node.js 4.9.1.Verification
npm teston the local Node.js runtime: 135 passingnpm testin the officialnode:4.9.1Linux amd64 container: 135 passingsscanf()state isolation.