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

Document the type and disposition options of StreamableFile #2938

Open
1 of 5 tasks
iliazeus opened this issue Jan 15, 2024 · 0 comments
Open
1 of 5 tasks

Document the type and disposition options of StreamableFile #2938

iliazeus opened this issue Jan 15, 2024 · 0 comments

Comments

@iliazeus
Copy link

iliazeus commented Jan 15, 2024

I'm submitting a...

  • Regression
  • Bug report
  • Feature request
  • Documentation issue or request (new chapter/page)
  • Support request => Please do not submit support request here, instead post your question on Stack Overflow.

Current behavior

Right now, only the res.set() way of setting the content-type of a StreamableFile is documented (here).

Expected behavior

Document the type (and, ideally, disposition) properties of StreamableFileOptions. Maybe even remove the res.set() example, leaving only the purely StreamableFile-based way

Minimal reproduction of the problem with instructions

N/A

What is the motivation / use case for changing the behavior?

Using the response object with a StreamableFile return is a potential bug source (too easy to forget the passthrough: true). Using the response object seems un-Nest-like when there's a way to do it using the returned object.

Environment

N/A

@iliazeus iliazeus changed the title Document the type and disposition options of StreamableFle Document the type and disposition options of StreamableFile Jan 15, 2024
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

No branches or pull requests

1 participant