Typescript declaration file for an external npm package - constructor

Question

I am using ES6 and Typescript for my Node project, however one library is a commonjs library. For that library, I created my own .d.ts declaration file:

module "@alpacahq/alpaca-trade-api" {
   export interface AlpacaParams { ... }

   // ...

   export class Alpaca implements Broker {

      // ...
      constructor(params: AlpacaParams);
   }

   export default Alpaca;
}

Everything works as expected, but I'm having a problem with the constructor.

If I use that class from within my project, and I try this:

this.alpaca = new Alpaca.Alpaca({...});

I get told that Alpaca.Alpaca is not a constructor. The only way it seems to work is if I do:

this.alpaca = new Alpaca.default({...});

I'm quite new to Typescript, so I'm sure I'm doing something wrong. Any ideas? The latter works, so I'm not blocked in my work, but I would like to set things up properly.

Thank you!

Edited to show TS config and imports

tsconfig.json

{
  "compilerOptions": {
    "target": "es6",
    "module": "es6",
    "lib": ["es6", "es5"],
    "sourceMap": true,
    "outDir": "dist",
    "rootDir": "src",
    "strict": true,
    "moduleResolution": "node",
    "typeRoots": ["./types"],
    "esModuleInterop": true,
    "resolveJsonModule": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  }
}

This is how I import it. Couldn't figure out how to make it work otherwise. If I import modules ES6 style, it breaks unless I use commonjs. If I use commonjs, I get an "export undefined" error.

import * as Alpaca from '@alpacahq/alpaca-trade-api';

Can you post your Typescript config and the way you import this module into your application code? There are a few combinations of choices there than can affect how the import works. — Just Jake
– Just Jake, Commented Jan 16, 2021 at 21:57
I restarted everything several times, that's not the issue, unfortunately. — gianpi
– gianpi, Commented Jan 24, 2021 at 0:09

Brian Burton · Accepted Answer · 2021-01-25 14:47:16Z

1

+50

The problem is that you're importing all named exports with import * meaning that Alpaca refers to the module and .default refers to the exported class. Instead you should be importing just the default member.

Change your import to look like this:

// Import default member from module
import Alpaca from '@alpacahq/alpaca-trade-api';

this.alpaca = new Alpaca({...});

answered Jan 25, 2021 at 14:47

Brian Burton

3,85020 silver badges34 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

gianpi Over a year ago

Thank you, that was it! I think I tried this first, but then I had a mistake in the module resolution setting, then when I fixed that, I didn't think to change the import back.

Collectives™ on Stack Overflow

Typescript declaration file for an external npm package - constructor

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related