pgtyped on more runtimes: avoid relying on global Buffer type
#612
Conversation
This file contains hidden or 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
SebastienGllmt
commented
Apr 29, 2025
| @@ -24,7 +24,7 @@ const DateOrString: Type = { | |||
| name: 'DateOrString', | |||
| definition: 'Date | string', | |||
| }; | |||
| const Bytes: Type = { name: 'Buffer' }; | |||
| const Bytes: Type = { name: 'Buffer', from: 'node:buffer' }; | |||
There was a problem hiding this comment.
Fortunately, this whole PR is just a single line (everything else is tests)
Closed
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.
Bufferis not a global type inherent to Typescript (comes from nodejs) so not all compiler options support it. Therefore, using pgtyped in those environments can lead to a compiler error on theBuffertypeTools usually solve this with two options:
node:buffermodule (soimport type { Buffer } from "node:buffer";works)Bufferto the global namespaceAdding to the global namespace is generally bad, so option (1) is usually preferred. However, pgtyped only supported option (2)
This PR changes so files generated from pgtyped include
import type { Buffer } from 'node:buffer';in the generated code so that projects using pgtyped don't have to pollute their global namespace to get the project working. This reduces the need for hacks like #262 (comment)