Repository navigation
docs(compiler): add a runnable public API quickstart - #1115
Merged
Merged
Conversation
Show source parsing, compilation, memory allocation and execution with a counter, an exported function and returned-cache reuse. Explain memory initialization, byte-addressed reads and matching shared-memory options.
irimias57
added
contributor
compiler
andorthehood
approved these changes
Oct 22, 2026
andorthehood
left a comment
andorthehood
left a comment
Member
There was a problem hiding this comment.
Thank you for the docs @jinchuntan !
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.
Closes #1076.
Adds a copyable JavaScript quickstart using the public compiler entry point: compile a counter and exported helper, allocate memory, initialize defaults, run the program and read its result. Includes cache reuse, matching shared-memory options, repository setup and links for the next steps.
Validation on Node 24.16.0:
npx nx run @8f4e/compiler:buildpassed.node quickstart.mjs: both outputs were42.