feat: add sendFile helper to serve a dynamically chosen file - #395
Open
SynthLuvr wants to merge 2 commits into
Open
feat: add sendFile helper to serve a dynamically chosen file#395SynthLuvr wants to merge 2 commits into
SynthLuvr wants to merge 2 commits into
Conversation
Fixes honojs#205 Adds a `sendFile(c, path, options)` helper, importable from `@hono/node-server/send-file`, that serves the file at a given path with the same behavior and features as the `serveStatic` middleware (MIME types, streaming, HEAD/OPTIONS, range requests, precompressed files, `root`/`index`/`onFound` options). This enables serving a file whose path is determined dynamically, like `res.sendFile()` of Express, and solves the use case of honojs/hono#4012 without requiring any changes to the core: `sendFile` always returns a `Response`, so it satisfies the current handler types. The file serving logic is shared between `serveStatic` and `sendFile` by extracting it into internal `findFile`/`serveFile` helpers, without changing the behavior of `serveStatic`.
- Derive SendFileOptions from ServeStaticOptions via Pick instead of duplicating the shared option fields - Split serveFile into findPrecompressedFile, createFileResponse and createRangeResponse so each unit is small and flat - Rewrite findFile with an early return instead of mutating locals - Drop comments that restate the code or reference serveStatic from shared code; keep the ones explaining non-obvious behavior - Fix a duplicated and misleading test name in send-file tests
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
1 participant
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 #205
Adds a
sendFile(c, path, options)helper, importable from@hono/node-server/send-file, that serves the file at a given path with the same behavior and features as theserveStaticmiddleware (MIME types, streaming, HEAD/OPTIONS, range requests, precompressed files,root/index/onFoundoptions). This enables serving a file whose path is determined dynamically, likeres.sendFile()of Express, and solves the use case of honojs/hono#4012 without requiring any changes to the core:sendFilealways returns aResponse, so it satisfies the current handler types.The file serving logic is shared between
serveStaticandsendFileby extracting it into internalfindFile/serveFilehelpers, without changing the behavior ofserveStatic.The author should do the following, if applicable
pnpm run format:fix && pnpm run lint:fixto format the code