Categorygithub.com/crushedpixel/jargo
modulepackage
0.0.2
Repository: https://github.com/crushedpixel/jargo.git
Documentation: pkg.go.dev

# Functions

DefaultCreateResourceHandler is the HandlerFunc used by the builtin JSON API Create Action.
DefaultDeleteResourceHandler is the HandlerFunc used by the builtin JSON API Delete Action.
DefaultIndexResourceHandler is the HandlerFunc used by the builtin JSON API Index Action.
DefaultShowResourceHandler is the HandlerFunc used by the builtin JSON API Show Action.
DefaultUpdateResourceHandler is the HandlerFunc used by the builtin JSON API Update Action.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewApiError returns a new ApiError from a status code, error code and error detail string.
NewApplication returns a new Application for the given Options.
NewErrorResponse returns a Response containing an error payload according to the JSON API spec.
NewRealtime returns a new Realtime instance for an Application and namespace using the default HandleConnection and MaySubscribe handlers, which allow all connections and subscriptions.
No description provided by the author
NormalizeNamespace ensures that the namespace starts and ends with a slash.
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
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ResponseToFerry creates a ferry.Response from a Response, invoking its Payload() method and handling any errors.

# Constants

DefaultMaxPageSize is the default maximum number of allowed entries per page.
No description provided by the author
MsgConnectionDisallowed is sent to the client if Realtime.HandleConnection returns false.
MsgConnectionTimeout is sent to the client if they don't send a connection message before Realtime.ConnectionMessageTimeout is exceeded.
No description provided by the author
No description provided by the author

# Variables

No description provided by the author
ErrInternalServerError is an ApiError indicating an unspecified internal error.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

An ApiError is a struct containing information about an error that occurred handling a request.
Application is the central component of jargo.
A Controller is responsible for all Actions related to a specific Resource.
No description provided by the author
No description provided by the author
No description provided by the author
A Filter contains values to be filtered by, each of the filter operators being connected via a logical OR, and all of the values for an operator being connected via a logical AND.
No description provided by the author
No description provided by the author
Options is used to configure an Application when creating it.
No description provided by the author
A Query is used to communicate with the database.
A Realtime instance allows clients to subscribe to resource instances via websocket.
No description provided by the author
implements api.Resource.
No description provided by the author
No description provided by the author

# Interfaces

Pagination is responsible for applying sorting and pagination settings to a Query.
No description provided by the author

# Type aliases

A CreateHandlerFunc is a function handling a create request.
A DeleteHandlerFunc is a function handling a delete request.
No description provided by the author
A HandlerFunc is a function handling a generic jargo request.
An IndexHandlerFunc is a function handling an index request.
No description provided by the author
A ShowHandlerFunc is a function handling a show request.
An UpdateHandlerFunc is a function handling an update request.