Add .d.ts files in samples.

Open
#530 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
38/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
cpp, javascript, node.js, typescript
Domain
developer-experience

Research direction

Start with src/1-getting-started/6_object_wrap/node-addon-api/myobject.cc and the related addon.js to compare the exposed MyObject API with the proposed declarations. Add the relevant .d.ts files for the samples, ensuring the listed plusOne, value, and multiply methods are represented with their shown types.

Written by the indexing model from the issue text.

Description

Hi,

Native Import in NodeJS do not provide any Typing by default.

src/1-getting-started/6_object_wrap/node-addon-api/myobject.cc register a class MyObject having a plusOne method.
but coding in addon.js will not give access to any typing.

My I open a PR to add d.ts
that contains somthink like:

class MyObject {
    public plusOne(): number;
    public value(): number;
    public multiply(num?: number): number;
}
Dominant language
C++
Stars
2.6k
Forks
602
No merged PRs in 30d

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.

More from nodejs/node-addon-examples

All issues in nodejs/node-addon-examples

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.