Repository navigation
feat: align final input chunks and clarify the public API - #60
Merged
Merged
Conversation
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.
Passing a final chunk to a manager's
end(chunk)silently discarded it in JavaScript, while core and Node inputs accepted that pattern. Record managers, prefix filters and decoded-input adapters now consume an optional final text/UTF-8 chunk before flushing and EOF validation. Final-chunk input uses the same type, mode, reentrancy and failure checks aswrite(); no scanner hot loop changes.Reorganize documentation around ordinary developer tasks: selected values, root retention, streaming strings, Web/Node input and JSONL. Add a methods/properties/options reference and error-ownership table; move plans/boundaries/reset to Advanced, migration to its own page, and contributor tooling to CONTRIBUTING. Keep old guide anchors as short navigation links and include new public pages in the npm archive. README shrinks from 82 to 64 lines.
Clarify that fulfilled
getValue()promises cannot be revoked by later syntax errors and do not prove whole-input validity. Add complete string/Web/Node examples, explicit async rejection ownership, and JSDoc for public methods and defaults. Mark final chunks on adapters/managers as unreleased since published beta.1; no release version or existing archive/tag changed.Validation:
Existing subscription names and callback timing are preserved. Internal declaration facade isolation remains a separate follow-up; no breaking observer-type split is introduced.
Remote CI passes on Node 22/24, Bun and Deno; CodeQL passes for JavaScript/TypeScript and Actions.