README
¶
flyingwhale-core
flyingwhale-core is a shared Go module for FlyingWhale app servers. It holds common packages extracted out of those servers. Server apps import this module rather than duplicating the same code.
| Package | Role |
|---|---|
buildinfo |
Reads the build revision and modified flag stamped into a binary. |
daykey |
Turns a time and a timezone offset into a calendar day key. |
httpx |
HTTP primitives shared by FlyingWhale servers: error envelope and code vocabulary, request id / logging / recover middlewares, rate limiting, router with route groups, Accept-Language negotiation, request-id slog handler. |
migrate |
SQLite migration runner driven by user_version. |
textmatch |
Multilingual keyword matching: word-boundary for alphabetic scripts, substring for CJK. |
webhook |
Checks a webhook request against a shared secret. |
This module is available under the MIT license.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package buildinfo reports the version control revision that the Go toolchain stamps into a binary at build time.
|
Package buildinfo reports the version control revision that the Go toolchain stamps into a binary at build time. |
|
Package daykey derives a calendar day key from an instant and a caller supplied timezone offset.
|
Package daykey derives a calendar day key from an instant and a caller supplied timezone offset. |
|
Package httpx provides the HTTP primitives shared by FlyingWhale servers: a JSON error envelope with a shared code vocabulary, request id and structured logging middlewares, a panic-recovery middleware, a rate limiter, a router with prefixed and middleware-chained route groups, Accept-Language negotiation, and a slog handler that correlates log lines with a request.
|
Package httpx provides the HTTP primitives shared by FlyingWhale servers: a JSON error envelope with a shared code vocabulary, request id and structured logging middlewares, a panic-recovery middleware, a rate limiter, a router with prefixed and middleware-chained route groups, Accept-Language negotiation, and a slog handler that correlates log lines with a request. |
|
Package migrate applies SQLite schema migrations tracked in a database's PRAGMA user_version.
|
Package migrate applies SQLite schema migrations tracked in a database's PRAGMA user_version. |
|
Package textmatch matches a keyword against a piece of text across scripts that delimit words differently.
|
Package textmatch matches a keyword against a piece of text across scripts that delimit words differently. |
|
Package webhook checks an inbound webhook request against a secret the receiver and the sender both hold.
|
Package webhook checks an inbound webhook request against a secret the receiver and the sender both hold. |
Click to show internal directories.
Click to hide internal directories.