request

package

v0.3.1 Latest Latest Go to latest Published: Nov 22, 2023 License: Apache-2.0 Imports: 2 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

This section is empty.

This section is empty.

This section is empty.

type Method[R any] struct {
	APIVersion string
	Method     string
}

Method is a constructor for an RPC request for a specific RPC method and API version.

func (cfg Method[R]) NewRequest(h jsonrpc.Handler, params ...jsonrpc.Param) Request[R]

type Relational[R any] struct {
	// contains filtered or unexported fields
}

Relational describe an initialized RPC request with access to a request handler and the option to include related resources.

func (req Relational[R]) Do(ctx context.Context) (*R, error)

Do performs the request against the server and returns the result.

func (req Relational[R]) Include(relationships ...string) Relational[R]

Include returns a request that appends the named relationships to the request include list.

type RelationalMethod[R any] struct {
	APIVersion string
	Method     string
}

RelationalMethod is a constructor for an RPC request for a specific RPC method and API version where named relationships can be included.

func (cfg RelationalMethod[R]) NewRequest(h jsonrpc.Handler, params ...jsonrpc.Param) Relational[R]

type Request[R any] struct {
	// contains filtered or unexported fields
}

Request describe an initialized RPC request with access to a request handler.

func (req Request[R]) Do(ctx context.Context) (*R, error)

Do performs the request against the server and returns the result.