# README
moov-io/base
Package github.com/moov-io/base implements core libraries used in multiple Moov projects. Refer to each projects documentation for more details.
Getting Started
You can either clone down the code (git clone [email protected]:moov-io/base.git) or grab the modules into your cache (go get -u github.com/moov-io/base).
Configuration
| Environmental Variable | Description | Default |
|---|---|---|
KUBERNETES_SERVICE_ACCOUNT_FILEPATH | Filepath to Kubernetes service account | /var/run/secrets/kubernetes.io |
Getting Help
| channel | info |
|---|---|
| Twitter @moov | You can follow Moov.io's Twitter feed to get updates on our project(s). You can also tweet us questions or just share blogs or stories. |
| GitHub Issue | If you are able to reproduce a problem please open a GitHub Issue under the specific project that caused the error. |
| moov-io slack | Join our slack channel to have an interactive discussion about the development of the project. |
Supported and Tested Platforms
- 64-bit Linux (Ubuntu, Debian), macOS, and Windows
Contributing
Yes please! Please review our Contributing guide and Code of Conduct to get started!
This project uses Go Modules and uses Go 1.14 or higher. See Golang's install instructions for help setting up Go. You can download the source code and we offer tagged and released versions as well. We highly recommend you use a tagged release for production.
License
Apbasee License 2.0 See LICENSE for details.
# Packages
Package admin implements an http.Server which can be used for operations and monitoring tools.
No description provided by the author
No description provided by the author
Copyright 2020 The Moov Authors Use of this source code is governed by an Apache License license that can be found in the LICENSE file.
No description provided by the author
Package http implements a core suite of HTTP functions for use inside Moov.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Functions
Has takes in a (potential) list of errors, and an error to check for.
ID creates a new random string for Moov systems.
Match takes in two errors and compares them, returning true if they match and false if they don't The matching is done by basic equality for simple errors (i.e.
NewTime wraps a time.Time value in Moov's base.Time struct.
Now returns a Time object with the current clock time set.
# Constants
ISO8601Format represents an ISO 8601 format with timezone.
# Variables
go:embed configs/config.default.yml.
go:embed migrations/*.up.sql migrations/*.up.mysql.sql.
go:embed migrations/*.up.postgres.sql.
go:embed migrations/*.up.spanner.sql.
# Structs
ParseError is returned for parsing reader errors.
Time is an time.Time struct that encodes and decodes in ISO 8601.
# Interfaces
UnwrappableError is an interface for errors that wrap another error with some extra context The interface allows these errors to get automatically unwrapped by the Match function.
# Type aliases
ErrorList represents an array of errors which is also an error itself.