Skip to content

Update streams.md to explain AOT modules #431

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.

Sign up for GitHub

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
wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −0
Open

Update streams.md to explain AOT modules #431

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/reference/streams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,15 @@ stream.on('data', (chunk) => { console.log(chunk.toString()); });

The [`NodeStream`](./dotnet/Microsoft.JavaScript.NodeApi.Interop/NodeStream) class provides the
.NET `Stream` adapter over a Node.js `Duplex`, `Readable`, or `Writable` stream.

When [building a module using C# Native AOT](../scenarios/js-aot-module), the Node API module needs
the `require()` function at initialization time to load the `node:stream` module. This must be
provided via a global variable *before* loading the AOT module itself.

```JS
global.node_api_dotnet = { require };
const Example = require(...);

const stream = Example.getContent();
stream.on('data', (chunk) => { console.log(chunk.toString()); });
```