fix: Fix TypeScript compilation in a Node.js environment#256
Merged
kou merged 1 commit intoapache:mainfrom Sep 11, 2025
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR fixes TypeScript compilation issues when using the Apache Arrow JavaScript library in Node.js environments by removing DOM types dependency and updating type definitions.
- Removes "DOM" from the TypeScript lib configuration to avoid browser-specific type assumptions
- Updates type definitions to use Node.js stream types instead of DOM-specific types
- Replaces
BufferSourcetype with a more generic parameter type forTextDecoder.decode()
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tsconfig/tsconfig.base.json | Removes "DOM" from TypeScript lib array to support Node.js environments |
| src/util/utf8.ts | Replaces DOM-specific BufferSource type with generic parameter type |
| src/util/compat.ts | Adds import for Node.js UnderlyingSink type |
| src/util/buffer.ts | Adds import for Node.js ReadableStreamReadResult type |
| src/io/interfaces.ts | Adds import for Node.js StreamPipeOptions type |
| src/io/adapters.ts | Adds import for Node.js ReadableStreamReadValueResult type |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
src/util/utf8.ts
Outdated
| const decoder = new TextDecoder('utf-8'); | ||
| /** @ignore */ | ||
| export const decodeUtf8 = (buffer?: BufferSource) => decoder.decode(buffer); | ||
| export const decodeUtf8 = (buffer?: Parameters<InstanceType<typeof TextDecoder>['decode']>[0]) => decoder.decode(buffer); |
There was a problem hiding this comment.
The type Parameters<InstanceType<typeof TextDecoder>['decode']>[0] is overly complex and hard to read. Consider extracting this to a type alias or using a simpler approach like ArrayBuffer | ArrayBufferView | null | undefined which matches the actual parameter type.
Suggested change
| export const decodeUtf8 = (buffer?: Parameters<InstanceType<typeof TextDecoder>['decode']>[0]) => decoder.decode(buffer); | |
| export const decodeUtf8 = (buffer?: ArrayBuffer | ArrayBufferView | null | undefined) => decoder.decode(buffer); |
trxcllnt
reviewed
Aug 22, 2025
src/util/utf8.ts
Outdated
| const decoder = new TextDecoder('utf-8'); | ||
| /** @ignore */ | ||
| export const decodeUtf8 = (buffer?: BufferSource) => decoder.decode(buffer); | ||
| export const decodeUtf8 = (buffer?: Parameters<InstanceType<typeof TextDecoder>['decode']>[0]) => decoder.decode(buffer); |
Contributor
There was a problem hiding this comment.
I think this is also an option?
Suggested change
| export const decodeUtf8 = (buffer?: Parameters<InstanceType<typeof TextDecoder>['decode']>[0]) => decoder.decode(buffer); | |
| export const decodeUtf8 = decoder.decode.bind(decoder); |
Fixes apache#45 This library runs in modern browsers, but is also intended for use in maintained versions of Node.js, which means that the TypeScript types cannot assume `"lib": ["DOM"]`. This change removes this `lib`, and updates the types to compile. Given that this library runs in the browser, it feels strange to import types from `node`, but this is no worse than the current situation, which already contains imports from `node`.
03c9554 to
5adda16
Compare
trxcllnt
approved these changes
Sep 10, 2025
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
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.
Fixes #45
This library runs in modern browsers, but is also intended for use in maintained versions of Node.js, which means that the TypeScript types cannot assume
"lib": ["DOM"].This change removes this
lib, and updates the types to compile.Given that this library runs in the browser, it feels strange to import types from
node, but this is no worse than the current situation, which already contains imports fromnode.