feat: Add TypeScript type definitions for S3StreamLogger #56
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Happy to merge this, but please remove typescript as a devDependency. |
|
Thanks for the feedback! I’ve removed TypeScript from the devDependencies as requested. Let me know if there’s anything else I can improve. 😊 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#49
This PR introduces TypeScript type definitions for the S3StreamLogger library. It enables developers using TypeScript to integrate the library seamlessly into their projects with type safety and enhanced developer experience.
Changes in this PR:
Added a index.d.ts file defining the type structure for the library.
Includes definitions for S3StreamLogger, S3StreamLoggerOptions, and associated classes/methods.
Provides documentation for key options and methods.
Why this is needed:
Many modern JavaScript projects use TypeScript for type safety.
Adding type definitions improves maintainability, supports IDE autocompletion, and reduces runtime errors for TypeScript users.