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

General Improvements #6

Open
GodBleak opened this issue Nov 13, 2023 · 0 comments · May be fixed by #7
Open

General Improvements #6

GodBleak opened this issue Nov 13, 2023 · 0 comments · May be fixed by #7

Comments

@GodBleak
Copy link

I've found several improvements I think this library could benefit from:

  • Switch (fully) to TypeScript: Moving the entire codebase to TypeScript would enhance type safety, improve developer experience, and align with modern TypeScript practices.

  • Use JSDoc: Having to constantly refer to the online docs can be a pain, so I think it would be beneficial to use JSDoc to get documentation in the editor.

  • Allow Dependency Injection for the HTTP Client: Offering the flexibility to inject any preferred HTTP client seems like a smart move. It opens up options for different use cases and preferences.

  • Ditch isomorphic-fetch: Given its lack of active maintenance and unresolved security advisories, replacing isomorphic-fetch with a more reliable solution would improve the security and reliability of the library.

  • Use Built-in Modules as the Default HTTP Client: Using Node.js' built-in modules like HTTPS or Fetch as the default HTTP client would reduce external dependencies, which would minimize potential security vulnerabilities.

  • Adopt Modern ECMAScript Standards over CommonJS: Transitioning to ECMAScript modules (ESM) would modernize the codebase.

I think these modifications would greatly improve the library's usability and security.

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 a pull request may close this issue.

1 participant