errors

README

errors

What is this?

A simple errors package that dynamically prepends the package name.

How to install

Open a terminal and run the following:

$ go get -u github.com/mjwhitta/errors

Usage

Below is a sample usage:

package mypackage

import (
    "os"

    "github.com/mjwhitta/errors"
)

func OpenFileByName(name string) (*os.File, error) {
    var e error
    var f *os.File

    if name == "" {
        return nil, errors.New("no name was provided")
    }

    if f, e = os.Open(name); e != nil {
        return nil, errors.Newf("failed to open %s: %w", name, e)
    }

    return f, nil
}

Links

• Source

Documentation

Index

• Constants
• func New(str string) error
• func Newf(format string, a ...any) error

Constants

const Version string = "1.0.4"

Version is the package version.

Functions

func New

func New(str string) error

New will return a new error with a prefixed package name.

func Newf

func Newf(format string, a ...any) error

Newf will return a new error from format string with a prefixed package name.