Question: how to use the project with TypeScript?

[dcsan]

Description

I'm tying to use some of the libs with TS and it's very unclear how to do this.

import * as ss from "@stdlib/nlp-sentencize"

gives an error:

This module can only be referenced with ECMAScript imports/exports by turning on the 'allowSyntheticDefaultImports' flag and referencing its default export.ts(2497)

so should i add that to a tsconfig ?

allowSyntheticDefaultImports: true

doesn't seem to help.

it seems most people write TS nowadays so a bit less of an onboarding brick wall would be helpful.

I searched the docs and can find no mention of how to import into a typescript project.

Related Issues

Related issues # , # , and # .

Questions

No.

Other

No.

Checklist

• I have read and understood the Code of Conduct.
• Searched for existing issues and pull requests.
• The issue name begins with RFC:.

[stdlib-bot]

👋 Hi there! 👋

And thank you for opening your first issue! We will get back to you shortly. 🏃 💨

[kgryte]

@Planeshifter Would you be able to help out with this?

[nilaygit-10721]

i can help you in this please assign me this

[yours7himanshu]

@kgryte So this issue is basically happening because TypeScript does not allow default import from CommonJs modules until some flags are setup. I think we can fix this by creating another configuration file for ES6 modules and adding build scripts in package-json to compile both format.

[Planeshifter]

We don't want to complicate our build step; shipping both CommonJS and ES6 modules is notoriously riddled with gotchas. As you said, one can configure one's TypeScript project to be able to consume CommonJS seamlessly. There should be plenty of guides available online and I have used @stdlib packages in TypeScript projects myself on multiple occasions.

To anyone facing this issue and not being able to resolve it, feel free to send a link to a repository where the problem is reproducible and I am happy to assist in updating the tsconfig.json to get it to work.

To the opening poster, if your tsconfig.json has "esModuleInterop": true or "allowSyntheticDefaultImports": true, you should be able to use

import ss from "@stdlib/nlp-sentencize";