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

TypeScript support #6

Open
mariansam opened this issue Aug 20, 2024 · 3 comments · May be fixed by #7
Open

TypeScript support #6

mariansam opened this issue Aug 20, 2024 · 3 comments · May be fixed by #7
Assignees
Labels
enhancement New feature or request

Comments

@mariansam
Copy link

Hi, thanks for your cool library :) it would be even better with TypeScript support or JSDoc type annotations + DefinitelyTyped @types/ package. Is this in the roadmap? Do you need any help with it?

@derhuerst
Copy link
Owner

I don't mind a typings file in this project, as the API will likely remain stable for the time being.

A definitely-typed/ package would of course work too!

@mariansam
Copy link
Author

Would you better like a .d.ts file or rewriting the project to .ts files (which would also probably mean rewriting it to ESM modules instead of CJS)? I think both would be pretty easy, I could do it at some point.

@derhuerst
Copy link
Owner

Would you better like a .d.ts file or rewriting the project to .ts files […]?

The former: .d.ts.

@derhuerst derhuerst added the enhancement New feature or request label Aug 27, 2024
roschaefer added a commit to roschaefer/sepa-payment-qr-code that referenced this issue Sep 13, 2024
Motivation
----------
This will add types.

The behaviour has changed minimally. The conditions don't check for
`key in data` but simply `data.key`. I think considering the
differences, it's perfectly for fine for this library.

How to test
-----------
1. `npm run build`
2. Have a look in `dist/`

close derhuerst#6
roschaefer added a commit to roschaefer/sepa-payment-qr-code that referenced this issue Sep 13, 2024
Motivation
----------
This will add types.

The behaviour has changed minimally. The conditions don't check for
`key in data` but simply `data.key`. I think considering the
differences, it's perfectly for fine for this library.

How to test
-----------
1. `npm run build`
2. Have a look in `dist/`

close derhuerst#6
roschaefer added a commit to roschaefer/sepa-payment-qr-code that referenced this issue Sep 13, 2024
Motivation
----------
This will add types.

The behaviour has changed minimally. The conditions don't check for
`key in data` but simply `data.key`. I think considering the
differences, it's perfectly for fine for this library.

How to test
-----------
1. `npm run build`
2. Have a look in `dist/`

close derhuerst#6
roschaefer added a commit to roschaefer/sepa-payment-qr-code that referenced this issue Sep 13, 2024
Motivation
----------
This will add types.

The behaviour has changed minimally. The conditions don't check for
`key in data` but simply `data.key`. I think considering the
differences, it's perfectly for fine for this library.

How to test
-----------
1. `npm run build`
2. Have a look in `dist/`

close derhuerst#6
roschaefer added a commit to roschaefer/sepa-payment-qr-code that referenced this issue Sep 13, 2024
Motivation
----------
This will add types.

The behaviour has changed minimally. The conditions don't check for
`key in data` but simply `data.key`. I think considering the
differences, it's perfectly for fine for this library.

How to test
-----------
1. `npm run build`
2. Have a look in `dist/`

close derhuerst#6
roschaefer added a commit to roschaefer/sepa-payment-qr-code that referenced this issue Sep 13, 2024
Motivation
----------
This will add types.

The behaviour has changed minimally. The conditions don't check for
`key in data` but simply `data.key`. I think considering the
differences, it's perfectly for fine for this library.

How to test
-----------
1. `npm run build`
2. Have a look in `dist/`

close derhuerst#6
roschaefer added a commit to roschaefer/sepa-payment-qr-code that referenced this issue Sep 13, 2024
Motivation
----------
This will add types.

The behaviour has changed minimally. The conditions don't check for
`key in data` but simply `data.key`. I think considering the
differences, it's perfectly for fine for this library.

How to test
-----------
1. `npm run build`
2. Have a look in `dist/`

close derhuerst#6
@roschaefer roschaefer linked a pull request Sep 13, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants