microsoft / microsoft/node-api-dotnet

Documentation is wrong and examples don't build

Open
#439 2 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C#
Stars
783
Forks
80
PR merge metrics
No merged PRs in 30d

Description

trying to build examples/jsdom gives

Restore complete (0.6s)
  jsdom failed with 1 error(s) (0.3s)
    error CS1729: 'NodeEmbeddingPlatform' does not contain a constructor that takes 2 arguments

And trying to follow the instructions for CS calling Node https://microsoft.github.io/node-api-dotnet/scenarios/dotnet-js.html indeed shows that

NodeEmbeddingPlatform nodejsPlatform = new(libnodePath, null);

is wrong, I think it is supposed to look like this:

NodeEmbeddingPlatform nodejsPlatform = new(new NodeEmbeddingPlatformSettings { LibNodePath = libnodePath});

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The failing example is in examples/jsdom, and the reported guidance is the CS calling Node page at the linked URL. Start by comparing the example and documentation's NodeEmbeddingPlatform construction with the shown NodeEmbeddingPlatformSettings form. Done means the example builds and the documentation matches the current API.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, node.js
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.