Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[RFC]: document usage with typescript #2545

Open
3 tasks done
dcsan opened this issue Jul 9, 2024 · 2 comments
Open
3 tasks done

[RFC]: document usage with typescript #2545

dcsan opened this issue Jul 9, 2024 · 2 comments
Assignees
Labels
Documentation Improvements, additions, or changes to documentation. TypeScript Issue involves or relates to TypeScript.

Comments

@dcsan
Copy link

dcsan commented Jul 9, 2024

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
Copy link
Contributor

👋 Hi there! 👋

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

@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. TypeScript Issue involves or relates to TypeScript. labels Jul 9, 2024
@kgryte
Copy link
Member

kgryte commented Jul 9, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements, additions, or changes to documentation. TypeScript Issue involves or relates to TypeScript.
Projects
None yet
Development

No branches or pull requests

4 participants