meta

package

v0.0.0-...-2c24670 Latest Latest Go to latest Published: Feb 23, 2022 License: Apache-2.0 Imports: 7 Imported by: 2

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

Repository

github.com/eyecuelab/kit

Documentation ¶

Index ¶

Constants
func APIURL(path string) string
func JSONApiRefLink(i interface{}, rel string) *jsonapi.Links
func JSONApiSelfLink(i interface{}) *jsonapi.Links
type ActionHolder
- func (ah *ActionHolder) AddAction(m method, name, urlHelper string, params ...interface{}) *JsonAPIAction
- func (ah *ActionHolder) RenderActions() *jsonapi.Meta
type Extendable
type FieldOption
- func FieldOptionsFromValues(values ...string) []FieldOption
type JsonAPIAction
type JsonAPIField
type Pagination

Constants ¶

View Source

const (
	DELETE method = "DELETE"
	GET    method = "GET"
	POST   method = "POST"
	PATCH  method = "PATCH"
	PUT    method = "PUT"

	InputText   inputType = "text"
	InputPass   inputType = "password"
	InputBool   inputType = "bool"
	InputNumber inputType = "number"
	InputSelect inputType = "select"

	IdString idType = "string"
	IdInt    idType = "int"
)

Variables ¶

This section is empty.

Functions ¶

func APIURL ¶

func APIURL(path string) string

APIURL full api url for the path

func JSONApiRefLink ¶

func JSONApiRefLink(i interface{}, rel string) *jsonapi.Links

JSONApiRefLink ref link helper

func JSONApiSelfLink ¶

func JSONApiSelfLink(i interface{}) *jsonapi.Links

JSONApiSelfLink self link helper

Types ¶

type ActionHolder ¶

type ActionHolder []*JsonAPIAction

func (*ActionHolder) AddAction ¶

func (ah *ActionHolder) AddAction(m method, name, urlHelper string, params ...interface{}) *JsonAPIAction

AddAction ...

func (*ActionHolder) RenderActions ¶

func (ah *ActionHolder) RenderActions() *jsonapi.Meta

RenderActions ...

type Extendable ¶

type Extendable interface {
	Extend() error
}

type FieldOption ¶

type FieldOption struct {
	Label string                 `json:"label,omitempty"`
	Value interface{}            `json:"value"`
	Meta  map[string]interface{} `json:"meta,omitempty"`
}

func FieldOptionsFromValues ¶

func FieldOptionsFromValues(values ...string) []FieldOption

type JsonAPIAction ¶

type JsonAPIAction struct {
	Method       string         `json:"method"`
	Name         string         `json:"name"`
	URL          string         `json:"url"`
	Multi        bool           `json:"multi"`
	Relationship bool           `json:"relationship"`
	Fields       []JsonAPIField `json:"fields"`
}

func (*JsonAPIAction) Field ¶

func (a *JsonAPIAction) Field(name string, inputType inputType, value interface{}, requred bool) *JsonAPIAction

Field ...

func (*JsonAPIAction) FieldWithOpts ¶

func (a *JsonAPIAction) FieldWithOpts(name string, inputType inputType, value interface{}, requred bool, options []FieldOption) *JsonAPIAction

FieldWithOpts add field with options to action

func (a *JsonAPIAction) Pagination(data *Pagination) *JsonAPIAction

Pagination add pagination meta to action

func (*JsonAPIAction) RelFields ¶

func (a *JsonAPIAction) RelFields(typeName string) *JsonAPIAction

RelFields ...

type JsonAPIField ¶

type JsonAPIField struct {
	Name      string        `json:"name"`
	InputType string        `json:"type"`
	Value     interface{}   `json:"value,omitempty"`
	Required  bool          `json:"required"`
	Options   []FieldOption `json:"options,omitempty"`
	Data      *Pagination   `json:"data,omitempty"`
}

type Pagination struct {
	Count int `json:"item_count"`
	Max   int `json:"max"`
	Page  int `json:"page"`
}

Source Files ¶

View all Source files

meta.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL