state

Documentation

Index

• Variables
• type State
  • func GetState(ctx context.Context) (*State, error)
  • func RequireState(ctx context.Context) *State
  • func (s State) Persist(ctx context.Context) error
  • func (s *State) SetWorkspace(ctx context.Context, w client.Workspace) error
• type Workspace

Variables

var (
	ErrNoState = fmt.Errorf("no Inngest state found")
)

Types

type State

type State struct {
	client.Client `json:"-"`

	SelectedWorkspace *Workspace     `json:"workspace,omitempty"`
	Credentials       []byte         `json:"credentials"`
	Account           client.Account `json:"account"`
}

State persists across each cli invokation, allowing functionality such as workspace switching, etc.

func GetState

func GetState(ctx context.Context) (*State, error)

func RequireState

func RequireState(ctx context.Context) *State

func (State) Persist

func (s State) Persist(ctx context.Context) error

func (*State) SetWorkspace

func (s *State) SetWorkspace(ctx context.Context, w client.Workspace) error

type Workspace

type Workspace struct {
	client.Workspace

	IsOverridden bool `json:"-"`
}

Workspace represents a single workspace within an Inngest account. The pertinent fields for the active workspace are marshalled into State.