client

Documentation

Index

• Variables
• func NewClient(token string) *api.Client
• func NewContext(ctx context.Context, c *Client) context.Context
• type Client
  • func FromContext(ctx context.Context) *Client
  • func FromToken(token string) *Client
  • func NewClientWithOptions(opts *NewClientOpts) *Client
  • func (c *Client) API() *api.Client
  • func (c *Client) Authenticated() bool
• type NewClientOpts

Variables

var ErrNoAuthToken = errors.New("No access token available. Please login with 'flyctl auth login'")

Functions

func NewClient

func NewClient(token string) *api.Client

func NewContext

func NewContext(ctx context.Context, c *Client) context.Context

NewContext derives a Context that carries c from ctx.

Types

type Client

type Client struct {
	IO *iostreams.IOStreams // TODO: remove
	// contains filtered or unexported fields
}

func FromContext

func FromContext(ctx context.Context) *Client

FromContext returns the Client ctx carries. It panics in case ctx carries no Client.

func FromToken

func FromToken(token string) *Client

func NewClientWithOptions

func NewClientWithOptions(opts *NewClientOpts) *Client

non-flyctl libraries use this when needing to specify logger, client name, and client version

func (*Client) API

func (c *Client) API() *api.Client

func (*Client) Authenticated

func (c *Client) Authenticated() bool

type NewClientOpts

type NewClientOpts struct {
	Token         string
	ClientName    string
	ClientVersion string
	Logger        api.Logger
}