How to use soundex-code in Typescript

I was trying to solve #245 and I’m a little confused about how to use soundex-code in Typescript.

I had previously tried soundex-code using just Node.js. This time, I was trying to set it up using Typescript. Since @types/soundex-code doesn’t exist, I tried making a custom type definition file: types/soundex-code/index.d.ts:

declare module 'soundex-code' {
    function soundex(
        value: any,
        maxLength?: any | undefined
    ): any;
    export = soundex;
}

and this is how I’m using it in src/index.ts:

import soundex from 'soundex-code';
console.log(soundex('lol'));

When I’m tsc-ing, this is what I get in dist/index.js:

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const soundex_code_1 = require("soundex-code");
console.log(soundex_code_1.default('lol'));
//# sourceMappingURL=index.js.map

which doesn’t work. To get it to work, this is the required change:

- console.log(soundex_code_1.default('lol'));
+ console.log(soundex_code_1('lol'));

Can someone please identify what I’m doing wrong here? 🙂

[alrifay]

try this import

import * as soundex from 'soundex-code';

[RaisinTen]

Finally, I fixed it! 😃 src/index.ts:

import soundex from 'soundex-code';
console.log(soundex('lol'));

src/@types/soundex-code/index.d.ts:

declare module 'soundex-code' {
    export default function soundex(
        value: string,
        maxLength?: number | undefined
    ): string;
}

and I set "esModuleInterop": true in tsconfig.json. Yay!

EDIT: Here’s another way without using default: src/index.ts:

import soundex from 'soundex-code';
console.log(soundex('lol'));

src/@types/soundex-code/index.d.ts:

declare module 'soundex-code' {
    export = soundex;
    function soundex(
        value: string,
        maxLength?: number | undefined
    ): string;
}

+ set "esModuleInterop": true in tsconfig.json