fiber/docs/api
Giovanni Rivera 31a503f699
🔥 Feature (v3): Add buffered streaming support (#3131)
* 🔥 Feature: Add SendStreamWriter to Ctx

Create a new `*DefaultCtx` method called `SendStreamWriter()`
that maps to fasthttp's `Response.SetBodyStreamWriter()`

* 🚨 Test: Validate regular use of c.SendStreamWriter()

- Adds Test_Ctx_SendStreamWriter to ctx_test.go

* 🚨 Test: (WIP) Validate interrupted use of c.SendStreamWriter()

- Adds Test_Ctx_SendStreamWriter_Interrupted to ctx_test.go
    - (Work-In-Progress) This test verifies that some data is
      still sent before a client disconnects when using the method
      `c.SendStreamWriter()`.

**Note:** Running this test reports a race condition when using
the `-race` flag or running `make test`. The test uses a channel
and mutex to prevent race conditions, but still triggers a warning.

* 📚 Doc: Add `SendStreamWriter` to docs/api/ctx.md

* 🩹 Fix: Remove race condition in Test_Ctx_SendStreamWriter_Interrupted

* 🎨 Styles: Update ctx_test.go to respect golangci-lint

* 📚 Doc: Update /docs/api/ctx.md to show proper `w.Flush()` error handling

* 📚 Doc: Add SendStreamWriter details to docs/whats_new.md

* 🎨 Styles: Update /docs/whats_new.md to respect markdownlint-cli2

* 🩹 Fix: Fix Fprintf syntax error in docs/whats_new.md

---------

Co-authored-by: M. Efe Çetin <efectn@protonmail.com>
2024-11-27 11:11:56 +01:00
..
_category_.json [v3 Maintenance]: Consolidate and Document Core Changes in v3 (#2934) 2024-04-23 08:18:19 +02:00
app.md 🔥 Feature: Add TestConfig to app.Test() for configurable testing (#3161) 2024-11-22 08:43:38 +01:00
bind.md 🐛 fix: Nil pointer dereference with Must Bind binding (#3171) 2024-11-25 11:51:36 +01:00
constants.md v3: Add support for consistent documentation using markdownlint (#3064) 2024-07-11 15:21:56 +02:00
ctx.md 🔥 Feature (v3): Add buffered streaming support (#3131) 2024-11-27 11:11:56 +01:00
fiber.md 🔥Feature: Add support for TrustProxy (#3170) 2024-10-17 08:29:03 +02:00
hooks.md 📚 Doc: Updates to API documentation and README (#3205) 2024-11-16 15:24:14 +01:00
log.md 📚 Doc: Updates to API documentation and README (#3205) 2024-11-16 15:24:14 +01:00
redirect.md 📚 Doc: Updates to API documentation and README (#3205) 2024-11-16 15:24:14 +01:00