internal

Documentation

Index

• func AsError[TError error](err error) (TError, bool)
• func FromSpaceliftError(err error) error
• func IsErrorType[TError error](err error) bool
• type Client
  • func NewClient(endpoint string, token string, requestsPerSecond, maxBurst *int) *Client
  • func (c *Client) Mutate(ctx context.Context, mutationName string, m interface{}, ...) error
  • func (c *Client) Query(ctx context.Context, queryName string, q interface{}, ...) error

Functions

func AsError

func AsError[TError error](err error) (TError, bool)

AsError is an inline form of errors.As.

func FromSpaceliftError

func FromSpaceliftError(err error) error

FromSpaceliftError wraps the error with a helpful message when encountering a Spacelift error. In this case an unauthorized error.

func IsErrorType

func IsErrorType[TError error](err error) bool

IsErrorType reports whether or not the type of any error in err's chain matches the Error type.

Types

type Client

type Client struct {
	Endpoint string
	Token    string
	Version  string
	Commit   string
	// contains filtered or unexported fields
}

Client represents a Spacelift client - in practice a thin wrapper over its (administrative) GraphQL API.

func NewClient

func NewClient(endpoint string, token string, requestsPerSecond, maxBurst *int) *Client

NewClient returns a new Spacelift client for the specified endpoint, token and limiter. If limiter is nil, no rate limit is imposed.

func (*Client) Mutate

func (c *Client) Mutate(ctx context.Context, mutationName string, m interface{}, variables map[string]interface{}) error

Mutate runs a GraphQL mutation.

func (*Client) Query

func (c *Client) Query(ctx context.Context, queryName string, q interface{}, variables map[string]interface{}) error

Query runs a GraphQL query.