-
Notifications
You must be signed in to change notification settings - Fork 126
Modified the docs/docs-using-js-api-support.md file and the docs/docs-using-extending.md file #1062
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
AyzeLYC
wants to merge
10
commits into
bytecodealliance:main
Choose a base branch
from
AyzeLYC:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 3 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
fe28424
Updated docs-using-js-api-support.md
AyzeLYC ed32cb1
Updated docs-using-extending.md
AyzeLYC 89f3114
Updated docs-using-extending.md
AyzeLYC ffd751d
Merge branch 'bytecodealliance:main' into main
AyzeLYC 9217629
Updated runner.js
AyzeLYC 158c33e
Updated docs-using-extending.md
AyzeLYC 576c3a4
Updated docs-using-extending.md
AyzeLYC 6b070ca
Merge branch 'bytecodealliance:main' into main
AyzeLYC 9990359
Updated runner.js
AyzeLYC e90e861
Merge branch 'bytecodealliance:main' into main
AyzeLYC File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,7 +11,7 @@ will compile to a library (that is, `cargo init --lib`). Javy plugins are | |
| written as Wasm components but converted to Wasm modules during the | ||
| initialization process. | ||
|
|
||
| Your `Cargo.toml` should look like: | ||
| Your `Cargo.toml` should look like the following data : | ||
|
|
||
| ```toml | ||
| [package] | ||
|
|
@@ -27,7 +27,7 @@ javy-plugin-api = "4.0.0" | |
| wit-bindgen = "0.44.0" | ||
| ``` | ||
|
|
||
| You'll need a WIT file in `wit/world.wit` that looks like: | ||
| You'll need a WIT file in `wit/world.wit` that looks like the following code : | ||
|
|
||
| ```wit | ||
| package yournamespace:[email protected]; | ||
|
|
@@ -39,7 +39,7 @@ world my-javy-plugin { | |
| } | ||
| ``` | ||
|
|
||
| If you want to use hostcalls in your plugin, you'll also need to include imports in your world. For example, if you wanted to import a function named `imported-function` that takes no arguments and doesn't return anything, it'll look like: | ||
| If you want to use hostcalls in your plugin, you'll also need to include imports in your world. For example, if you wanted to import a function named `imported-function` that takes no arguments and doesn't return anything, it'll look like : | ||
|
|
||
| ```wit | ||
| package yournamespace:[email protected]; | ||
|
|
@@ -62,7 +62,7 @@ modules. See our documentation on | |
| [using complex data types in Wasm functions](./contributing-complex-data-types.md) | ||
| for more details. | ||
|
|
||
| For the world with the imported function, the `src/lib.rs` should look like: | ||
| For the world with the imported function, the `src/lib.rs` should look like : | ||
|
|
||
| ```rust | ||
| use javy_plugin_api::{ | ||
|
|
@@ -102,7 +102,7 @@ javy_plugin!("my-javy-plugin", Component, config, modify_runtime); | |
| export!(Component); | ||
| ``` | ||
|
|
||
| If you do not want to use the `javy_plugin!` macro for whatever reason, you can use the underlying APIs in `src/lib.rs` directly: | ||
| If you do not want to use the `javy_plugin!` macro for whatever reason, you can use the underlying APIs in `src/lib.rs` directly : | ||
|
|
||
| ```rust | ||
| use std::process; | ||
|
|
||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.