Categorygithub.com/go-corelibs/notify
modulepackage
1.0.2
Repository: https://github.com/go-corelibs/notify.git
Documentation: pkg.go.dev

# README

godoc codecov Go Report Card

notify - level managed stdout/stderr notifier

notify is a package for managing outputting various levels of informative notices to STDOUT and STDERR.

Installation

> go get github.com/go-corelibs/notify@latest

Examples

Notifier

func main() {
    notifier := notify.New(notify.Info).Make()
    notifier.Error("this is printed to os.Stderr\n")
    notifier.Info("this is printed to os.Stdout\n")
    // the following Debug call will not output anything becuase the level
    // of the notifier is currently set to Info (which is less than Debug)
    notifier.Debug("this would be printed to os.Stdout\n")
    notifier.ModifyLevel(notify.Debug) // modifying built notifier at runtime
    notifier.Debug("this is printed to os.Stdout\n")
}

Go-CoreLibs

Go-CoreLibs is a repository of shared code between the Go-Curses and Go-Enjin projects.

License

Copyright 2023 The Go-CoreLibs Authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use file except in compliance with the License.
You may obtain a copy of the license at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

# Functions

New constructs a new Builder instance.

# Constants

Debug configures the Notifier to produce all outputs.
Error configures the Notifier to only produce error output.
Info configures the Notifier to produce normal and error output.
Quiet configures the Notifier to produce no output.

# Structs

No description provided by the author

# Interfaces

Builder is the interface for constructing new Notifier instances.
No description provided by the author

# Type aliases

Level specifies the verbosity of a Notifier.