Node C++ Addon Typescript declaration file

Question

Node C++ Addon Typescript declaration file

I have developed a Node C++ Addon that wraps a class similar to the one outlined in the official Node documentation. By using require(), I am able to access my addon and retrieve the constructor for my class in order to instantiate it.

const { MyClass } = require('myaddon');
const obj = new MyClass('data');

My next goal is to replicate this process using TypeScript. However, I am struggling to find the correct combination of .d.ts file and import statement to achieve this. Ideally, I would like to define my class within the module and specify that it has a constructor that accepts a string parameter. This way, I could simply do:

import { MyClass } from 'myaddon';
const obj = new MyClass('data');

Has anyone come across any examples of how to accomplish this task?

typescript node.js-addon

Answer 1

Answer №1

After taking the advice of @ZachB, I have finally figured it out. I made a myaddon.ts file that contains the following:

const myaddon = require('./build/release/myaddon')

export interface MyClass {
    myMethod(arg: string): number
}

export var MyClass: {
    new(param: string): MyClass
} = myaddon.MyClass

Now you can utilize it like this:

import { MyClass } from 'myaddon'

const thing: MyClass = new MyClass('something')
const answer: number = thing.myMethod('blah')

Answer 2

After taking the advice of @ZachB, I have finally figured it out. I made a myaddon.ts file that contains the following:

const myaddon = require('./build/release/myaddon')

export interface MyClass {
    myMethod(arg: string): number
}

export var MyClass: {
    new(param: string): MyClass
} = myaddon.MyClass

Now you can utilize it like this:

import { MyClass } from 'myaddon'

const thing: MyClass = new MyClass('something')
const answer: number = thing.myMethod('blah')

Answer 3

Answer №2

While there may be alternative approaches, I personally implement the following approach:

// bindings.ts
// Define the interface for my addon:
export interface MyBindings {
    myMethod1: (arg1: number) => null;
}
// Require and load it
var myClass: MyBindings = require("./build/release/myaddon");
export default myClass;

Subsequently, I access it from different sections of my module using

import bindings from "../bindings"

.

Answer 4

While there may be alternative approaches, I personally implement the following approach:

// bindings.ts
// Define the interface for my addon:
export interface MyBindings {
    myMethod1: (arg1: number) => null;
}
// Require and load it
var myClass: MyBindings = require("./build/release/myaddon");
export default myClass;

Subsequently, I access it from different sections of my module using

import bindings from "../bindings"

.

Answer 5

Answer №3

If you find yourself in need of making an ambient declaration (like I did when working with Node-Gyp + Webpack), you can create a file named mymodule.d.ts:

declare module "*mymodule.node" {
    declare class SpaceObject {}

    declare class Object extends SpaceObject {
        getObjectName(): number;
        createMesh(data, notes, duplicate?);
    }

    var Enabler: {
        enableModules(moduleName: string, version: string);
    };
}

After that, you can import it like this:

import myModule from '../build/Release/mymodule.node';

Answer 6

If you find yourself in need of making an ambient declaration (like I did when working with Node-Gyp + Webpack), you can create a file named mymodule.d.ts:

declare module "*mymodule.node" {
    declare class SpaceObject {}

    declare class Object extends SpaceObject {
        getObjectName(): number;
        createMesh(data, notes, duplicate?);
    }

    var Enabler: {
        enableModules(moduleName: string, version: string);
    };
}

After that, you can import it like this:

import myModule from '../build/Release/mymodule.node';

Answer 7

Answer №4

Inspired by Nick Kallen's approach, here is another method to achieve the same result.

By utilizing a naming technique, you can specify the file extension in Typescript:

import test = require("../test/build/Release/hello.node");

After compilation to JavaScript, the file will be recognized as hello.node. However, Typescript will identify it by its name along with a .d.ts extension.

Your *.node directory structure should include:

-hello.node

-hello.node.d.ts

-if-windows-hello.dll

Within my hello.node.d.ts file, the content is as follows:

export const hello: () => string;

Answer 8

Inspired by Nick Kallen's approach, here is another method to achieve the same result.

By utilizing a naming technique, you can specify the file extension in Typescript:

import test = require("../test/build/Release/hello.node");

After compilation to JavaScript, the file will be recognized as hello.node. However, Typescript will identify it by its name along with a .d.ts extension.

Your *.node directory structure should include:

-hello.node

-hello.node.d.ts

-if-windows-hello.dll

Within my hello.node.d.ts file, the content is as follows:

export const hello: () => string;

Node C++ Addon Typescript declaration file

Answer №1

Answer №2

Answer №3

Answer №4

Similar questions

I'm sorry, we couldn't locate the module: Unable to find the path '../types/index'

A Typescript type that verifies whether a provided key, when used in an object, resolves to an array

Tips for defining a function across a Angular project

Passing a FormGroup from an Angular 2 component as a parameter

What is the process of playing blob videos (avi, mov) in Angular14?

Instructions on invoking a function when a button is clicked

The name 'CallSite' is missing from the Error stack trace when working with Node.js and TypeScript

The 'ObjectID' property is not present in the 'CollectionStatic' data type

Problem with Typescript: The type '{ x;y }' is required to have a '[Symbol.iterator]()' method

Obtaining the count of a specific column in Angular 6 by grouping objects based on the same value in an array

A guide on including a class to a DOM element in Angular 6 without relying on Jquery

What sets apart calling an async function from within another async function? Are there any distinctions between the two methods?

Issue with Angular 4: Radio button defaults not being set

Typescript declaration specifies the return type of function properties

Use TypeScript to cast the retrieved object from the local storage

Expressjs - Error: Headers already sent to the client and cannot be set

Angular 6: Harnessing the Power of RouterLinks

How to Retrieve a Symbol in TypeScript

Exploring ways to retrieve checkbox values instead of boolean values upon submission in Angular

Issue encountered while using Typescript with mocha: Unable to utilize import statement outside a module