https://github.com/morebec/go-errors
Go package built on top of go's standard errors
https://github.com/morebec/go-errors
Last synced: about 1 year ago
JSON representation
Go package built on top of go's standard errors
- Host: GitHub
- URL: https://github.com/morebec/go-errors
- Owner: Morebec
- Created: 2023-01-10T03:48:36.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-30T09:53:51.000Z (about 3 years ago)
- Last Synced: 2025-02-01T23:45:10.295Z (over 1 year ago)
- Language: Go
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# go-errors
[](https://github.com/Morebec/go-errors/actions/workflows/go.yml)
This package is a thin wrapper around the Go standard library's errors
package that provides additional functions for defining and manipulating errors. It is designed to be compatible with
the standard library's errors package, but also provides additional features such as the ability to define custom error
codes (for translation or representation in UIs) and the ability to wrap multiple errors in a single error value.
## Features
- Define custom error codes with the `Error` type.
- Wrap multiple errors in a single error value with the `Group` type.
- Retrieve the cause of an error with the `Unwrap` method.
## Getting Started
To get started with the `go-errors` package, you can install it with the following command:
```bash
go get github.com/morebec/go-errors
```
## Examples
Here are a few examples, for more examples please consult the `errors_test.go` file.
### Adding context to an error
```go
_, err := os.ReadFile(f)
if err != nil {
return errors.WrapWithMessage(err, "reading_failure", "there was an error reading the file")
}
```
### Handling an error with a specific error code
```go
import "github.com/morebec/go-errors/errors"
func doSomething() error {
// Return a new error with the "invalid_input" code.
return errors.New("invalid_input")
// alternatively if you also want to provide a message
return errors.NewWithMessage("invalid_input", "The input provided was invalid.")
}
func main() {
err := doSomething()
if err != nil {
if errors.HasCode(err, "invalid_input") {
// Do something ...
}
}
}
```
### Contributions
We welcome contributions to the `go-errors` package! If you have an idea for a new feature or have found a bug,
please open an issue to discuss it. If you'd like to contribute code, please open a pull request with your changes.
License
The `go-errors` package is licensed under the MIT License.