Add shared File type in interfaces.ts#119
Merged
Geomitron merged 1 commit intoGeomitron:masterfrom Apr 21, 2026
Merged
Conversation
The `{ fileName: string; data: Uint8Array }` shape was inlined in every
scan-chart API that takes a chart folder — scanChart, parseChartAndIni,
scanIni, scanAudio, scanImage, scanVideo, and the test helpers. Extract
it as a named type `File` (exported from `interfaces.ts`) so consumers
and downstream writer APIs reference a single canonical shape. No
runtime change; purely a type rename.
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
2 participants
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.
Summary
Extract the
{ fileName: string; data: Uint8Array }shape that's inlined in every scan-chart folder-taking API into a namedFiletype ininterfaces.ts. No runtime change; purely a rename.Callsites updated:
scanChart,scanChartFolder,getChartMD5(src/index.ts)parseChartAndIni,findChartData(src/chart/parse-chart-and-ini.ts)scanIni,findIniData(src/ini/ini-scanner.ts)scanAudio,findAudioData(src/audio/audio-scanner.ts)scanImage,findAlbumData(src/image/image-scanner.ts)scanVideo,findVideoData(src/video/video-scanner.ts)ini-scanner.test.tsandderived-flags.test.tsContext
This lives at the bottom of the writer stack so that the downstream
ChartDocumentPR can replace its bespokeChartAssettype with a reference toFile. Addresses review feedback on #109 asking for a shared type before landing that PR.Test plan
npx vitest run— 586/586 pass (no semantic change)Fileexport