mirror of
https://github.com/gofiber/fiber.git
synced 2025-05-11 10:10:40 +00:00
8b1f9260a3
Fix typos, and make docs more consistent This fixes several typos in the ISSUE_TEMPLATES, as well as improve their readability, also makes the documentation markdowns more consistent
68 lines
1.4 KiB
Markdown
68 lines
1.4 KiB
Markdown
---
|
|
id: recover
|
|
title: Recover
|
|
---
|
|
|
|
Recover middleware for [Fiber](https://github.com/gofiber/fiber) that recovers from panics anywhere in the stack chain and handles the control to the centralized [ErrorHandler](https://docs.gofiber.io/error-handling).
|
|
|
|
## Signatures
|
|
|
|
```go
|
|
func New(config ...Config) fiber.Handler
|
|
```
|
|
|
|
## Examples
|
|
|
|
Import the middleware package that is part of the Fiber web framework
|
|
|
|
```go
|
|
import (
|
|
"github.com/gofiber/fiber/v2"
|
|
"github.com/gofiber/fiber/v2/middleware/recover"
|
|
)
|
|
```
|
|
|
|
After you initiate your Fiber app, you can use the following possibilities:
|
|
|
|
```go
|
|
// Initialize default config
|
|
app.Use(recover.New())
|
|
|
|
// This panic will be caught by the middleware
|
|
app.Get("/", func(c *fiber.Ctx) error {
|
|
panic("I'm an error")
|
|
})
|
|
```
|
|
|
|
## Config
|
|
|
|
```go
|
|
// Config defines the config for middleware.
|
|
type Config struct {
|
|
// Next defines a function to skip this middleware when returned true.
|
|
//
|
|
// Optional. Default: nil
|
|
Next func(c *fiber.Ctx) bool
|
|
|
|
// EnableStackTrace enables handling stack trace
|
|
//
|
|
// Optional. Default: false
|
|
EnableStackTrace bool
|
|
|
|
// StackTraceHandler defines a function to handle stack trace
|
|
//
|
|
// Optional. Default: defaultStackTraceHandler
|
|
StackTraceHandler func(c *fiber.Ctx, e interface{})
|
|
}
|
|
```
|
|
|
|
## Default Config
|
|
|
|
```go
|
|
var ConfigDefault = Config{
|
|
Next: nil,
|
|
EnableStackTrace: false,
|
|
StackTraceHandler: defaultStackTraceHandler,
|
|
}
|
|
```
|