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.

Sign up for GitHub

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

errors: include a link in the Error() message #149

Merged
merged 1 commit into from
Jan 8, 2024
Merged

errors: include a link in the Error() message #149

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion errors.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package ngrok
import (
"fmt"
"net/url"
"strings"
)

// Error is an error enriched with a specific ErrorCode.
Expand Down Expand Up @@ -139,8 +140,14 @@ type ngrokError struct {
ErrCode string
}

const errUrl = "https://ngrok.com/docs/errors"

func (m ngrokError) Error() string {
return m.Message + "\n\n" + m.ErrCode
out := m.Message
if m.ErrCode != "" {
out = fmt.Sprintf("%s\n\n%s/%s", out, errUrl, strings.ToLower(m.ErrCode))
}
return out
}

func (m ngrokError) Msg() string {
Expand Down