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

Added TypeScript instructions #16

Merged
merged 2 commits into from
Nov 23, 2021

Conversation

pjotrsavitski
Copy link
Contributor

Updated README file to include instructions for using the package with TypeScript.

Updated README file to include instructions for using the package with TypeScript
@codecov-commenter
Copy link

Codecov Report

Merging #16 (4f540e8) into master (fc0028a) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##            master       #16   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines           22        22           
=========================================
  Hits            22        22           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fc0028a...4f540e8. Read the comment docs.

README.md Outdated Show resolved Hide resolved
Co-authored-by: Richie Bendall <richiebendall@gmail.com>
@pjotrsavitski
Copy link
Contributor Author

Not sure why, but GitHub seems to be removing the closing part for the suggested multi line comment.

@Uzlopak
Copy link

Uzlopak commented Nov 19, 2021

Why not providing the d.ts folder in this repo and referencing it in the package.json in the typings attribute?

Then you would provide the typings automatically without the necessity to install another dependency and if the typings are incomplete or wrong we just have to change them in this package and not somewhere else.

@Richienb
Copy link
Contributor

@Uzlopak Sometimes, a maintainer is not interested in maintaining their own type definitions. We can only speculate for now.

@niftylettuce niftylettuce merged commit ba20ed2 into spamscanner:master Nov 23, 2021
@pjotrsavitski
Copy link
Contributor Author

It seems that closing code block is missing. Probably due to some changes during resolving code comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants