docs: clarify ambient access, observation waits, and module identity - #29
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
1 participant
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.
Ambient context reads currently throw outside an execution, but the README's
use()description can be read as returning undefined there. Clarify the active-execution requirement in README and JSDoc, and documentpeekState()?.context.signalfor integrations that intentionally support either context.Add a bounded observation example that races independently owned settlement promises without terminating processes, including timer/listener cleanup and the distinction between domain settlement and Job lifetime. Explain duplicate key-definition modules versus duplicate runner runtimes, preserve Symbol identity, and recommend required bindings for adapters whose defaults have side effects.
Validation:
pnpm format && pnpm check && pnpm build && pnpm test && pnpm packpassed (131 tests). No runtime behavior or API changes.