bodypredicate

package

v0.0.5 Latest Latest Go to latest Published: Apr 2, 2021 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

The body predicate checks the Content-Type of the incoming request and/or parse its body.

Option	Required	Description
`mime`		If set, check that the Mime type of the Content-Type header value of the incoming request matches this value
`type`		Can be `string` or `json`. If set, the body is read and parsed accordingly to this value.
`limit`		Max body size in bytes. If received body is larger, it will be truncated. Default is 1232896 (1Mb).

Field	Type	Description
`result`	boolean	false if `mime` was not matched (if set) or body cannot be parsed accordingly to `type` (if set) or method is GET, HEAD or DELETE
`payload`	depends on `type`	It `type` is set, contains the parsed body

- body:
    mime: application/json
    type: json
  register: body

- log:
    msg: body.payload.token

This section is empty.

View Source

var Name = "body"

Name of the predicate

func New() genapid.Predicate

New returns a new Predicate

type Predicate struct {
	// contains filtered or unexported fields
}

Predicate is a genapid.Predicate interface that describes the predicate

func (predicate *Predicate) Call(log zerolog.Logger, c *ctx.Ctx) bool

Call evaluates the predicate

func (predicate *Predicate) Name() string

Name returns the name of the predicate

func (predicate *Predicate) Params() interface{}

Params returns a reference to a struct params accepted by the predicate

func (predicate *Predicate) Result() ctx.Result

Result returns data set by the predicate