README
¶
pkg
Here you can find all publicly available packages, where most* packages are also used by shinpuru.
I try to document these packages as well as possible and keep the API as consistent as possible so that you can rely on these packages.
In some packages, you might find a v2, v3 (, ...) directory. When I need to change the API of a package so that it would break something, I create a new version which contains the updated version so that the original version maintains consistency.
You can simply go get these packages.
go get github.com/zekroTJA/shinpuru/pkg/<package_name>
Then, you can import it in your own application.
package main
import (
"fmt"
"github.com/zekroTJA/shinpuru/pkg/bytecount"
)
func main() {
fmt.Println(bytecount.Format(123456789))
// -> "117.738 MiB"
}
*Some packages (or pakcage versions) are actually not anymore used in shinpuru because of new features and updates. For example, package lctimer was replaced with robfig/cron/v3, so the package is not used anymore but will be provided further to maintain package consistency.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package acceptmsg provides a message model for discordgo which can be accepted or declined via message reactions.
|
Package acceptmsg provides a message model for discordgo which can be accepted or declined via message reactions. |
|
v2
Package acceptmsg provides a message model for discordgo which can be accepted or declined via message reactions.
|
Package acceptmsg provides a message model for discordgo which can be accepted or declined via message reactions. |
|
Package angularservice provides bindings to start an Angular development server via the Angular CLI.
|
Package angularservice provides bindings to start an Angular development server via the Angular CLI. |
|
Package argp is a stupid simple flag (argument) parser which allows to parse flags without panicing when non-registered flags are passed.
|
Package argp is a stupid simple flag (argument) parser which allows to parse flags without panicing when non-registered flags are passed. |
|
Package boolutil provides simple utility functions around booleans.
|
Package boolutil provides simple utility functions around booleans. |
|
Package bytecount provides functionalities to format byte counts.
|
Package bytecount provides functionalities to format byte counts. |
|
Package checksum provides functions to generate a hash sum from any given object.
|
Package checksum provides functions to generate a hash sum from any given object. |
|
Package color provides general utilities for image/color objects and color codes.
|
Package color provides general utilities for image/color objects and color codes. |
|
Package ctype provides some custom types with useful function extensions.
|
Package ctype provides some custom types with useful function extensions. |
|
package discordoauth provides fasthttp handlers to authenticate with via the Discord OAuth2 endpoint.
|
package discordoauth provides fasthttp handlers to authenticate with via the Discord OAuth2 endpoint. |
|
v2
package discordoauth provides fasthttp handlers to authenticate with via the Discord OAuth2 endpoint.
|
package discordoauth provides fasthttp handlers to authenticate with via the Discord OAuth2 endpoint. |
|
Package discordutil provides general purpose extensuion functionalities for discordgo.
|
Package discordutil provides general purpose extensuion functionalities for discordgo. |
|
Package embedbuilder provides a builder pattern to create discordgo message embeds.
|
Package embedbuilder provides a builder pattern to create discordgo message embeds. |
|
Package etag implements generation functionalities for the ETag specification of RFC7273 2.3.
|
Package etag implements generation functionalities for the ETag specification of RFC7273 2.3. |
|
Package fetch provides functionalities to fetch roles, channels, members and users by so called resolavbles.
|
Package fetch provides functionalities to fetch roles, channels, members and users by so called resolavbles. |
|
Package giphy provides a crappy and inclomplete - but at least bloat free - Giphy API client.
|
Package giphy provides a crappy and inclomplete - but at least bloat free - Giphy API client. |
|
Package hammertime provides functionailities to format a time.Time into a Discord timestamp mention.
|
Package hammertime provides functionailities to format a time.Time into a Discord timestamp mention. |
|
Package hashutil provides general utility functionalities to generate simple and fast hashes with salt and pepper.
|
Package hashutil provides general utility functionalities to generate simple and fast hashes with salt and pepper. |
|
Package httpreq provides general utilities for around net/http requests for a simpler API and extra utilities for parsing JSON request and response boddies.
|
Package httpreq provides general utilities for around net/http requests for a simpler API and extra utilities for parsing JSON request and response boddies. |
|
Package inline provides general inline operation functions like inline if or null coalescence.
|
Package inline provides general inline operation functions like inline if or null coalescence. |
|
Package intutil provides some utility functionalities for integers.
|
Package intutil provides some utility functionalities for integers. |
|
Package jdoodle provides an API wrapper for the jdoodle execute and credit-spent REST API.
|
Package jdoodle provides an API wrapper for the jdoodle execute and credit-spent REST API. |
|
Package lctimer provides a life cycle timer which calls registered callback handlers on timer elapse.
|
Package lctimer provides a life cycle timer which calls registered callback handlers on timer elapse. |
|
Package limiter provides a fiber middleware for a bucket based request rate limiter.
|
Package limiter provides a fiber middleware for a bucket based request rate limiter. |
|
Package lokiwriter implements rogu.Writer to push logs to a Grafana Loki instance.
|
Package lokiwriter implements rogu.Writer to push logs to a Grafana Loki instance. |
|
Package md provides some simple markdown fowmatting utilities.
|
Package md provides some simple markdown fowmatting utilities. |
|
Package mimefix provides functionalities to bypass this issue with fasthttp on windows hosts*: https://github.com/golang/go/issues/32350
|
Package mimefix provides functionalities to bypass this issue with fasthttp on windows hosts*: https://github.com/golang/go/issues/32350 |
|
Package mody allows to modify fields in an object.
|
Package mody allows to modify fields in an object. |
|
Package msgcollector provides functionalities to collect messages in a channel in conect of a single command request.
|
Package msgcollector provides functionalities to collect messages in a channel in conect of a single command request. |
|
Package multierror impements handling multiple errors as one error object.
|
Package multierror impements handling multiple errors as one error object. |
|
Package onetimeout provides short duration valid JWT tokens which are only valid exactly once.
|
Package onetimeout provides short duration valid JWT tokens which are only valid exactly once. |
|
v2
Package onetimeout provides short duration valid JWT tokens which are only valid exactly once.
|
Package onetimeout provides short duration valid JWT tokens which are only valid exactly once. |
|
Package permissions provides functionalities to calculate, update and merge arrays of permission domain rules.
|
Package permissions provides functionalities to calculate, update and merge arrays of permission domain rules. |
|
Package random provides some general purpose cryptographically pseudo-random utilities.
|
Package random provides some general purpose cryptographically pseudo-random utilities. |
|
Package rediscmdstore provides an implementation of github.com/zekrotja/ken/store.CommandStore using a redis client to store the command cache.
|
Package rediscmdstore provides an implementation of github.com/zekrotja/ken/store.CommandStore using a redis client to store the command cache. |
|
Package regexutil provides additional utility functions used with regular expressions.
|
Package regexutil provides additional utility functions used with regular expressions. |
|
Package roleutil provides general purpose utilities for discordgo.Role objects and arrays.
|
Package roleutil provides general purpose utilities for discordgo.Role objects and arrays. |
|
Package slices adds generic utility functionalities for slices.
|
Package slices adds generic utility functionalities for slices. |
|
Package startuptime provides simple functionalities to measure the startup time of an application.
|
Package startuptime provides simple functionalities to measure the startup time of an application. |
|
Package stringutil provides generl string utility functions.
|
Package stringutil provides generl string utility functions. |
|
Package thumbnail provides simple functionalities to generate thumbnails from images with a max witdh or height.
|
Package thumbnail provides simple functionalities to generate thumbnails from images with a max witdh or height. |
|
Package timerstack provides a timer which can execute multiple delayed functions one after one.
|
Package timerstack provides a timer which can execute multiple delayed functions one after one. |
|
Package timeutil provides some general purpose functionalities around the time package.
|
Package timeutil provides some general purpose functionalities around the time package. |
|
Package twitchnotify provides functionalities to watch the state of twitch streams and notifying changes by polling the twitch REST API.
|
Package twitchnotify provides functionalities to watch the state of twitch streams and notifying changes by polling the twitch REST API. |
|
Package validators provides some (more or less) general purpose validator functions for user inputs.
|
Package validators provides some (more or less) general purpose validator functions for user inputs. |
|
Package versioncheck provides endpoints to retrieve version information via different providers and utilities to compare versions.
|
Package versioncheck provides endpoints to retrieve version information via different providers and utilities to compare versions. |
|
Package voidbuffer provides a simple, concurrency proof push buffer with a fixed size which "removes" firstly pushed values when fully filled.
|
Package voidbuffer provides a simple, concurrency proof push buffer with a fixed size which "removes" firstly pushed values when fully filled. |
|
v2
Package voidbuffer provides a simple, concurrency proof push buffer with a fixed size which "removes" firstly pushed values when fully filled.
|
Package voidbuffer provides a simple, concurrency proof push buffer with a fixed size which "removes" firstly pushed values when fully filled. |
Click to show internal directories.
Click to hide internal directories.