login

Documentation

Overview

Package login handles login and authentication with Encore's platform.

Index

• func WithAuthKey(authKey string) (*conf.Config, error)
• type Flow
  • func Begin() (f *Flow, err error)
  • func (f *Flow) Close()

Functions

func WithAuthKey

func WithAuthKey(authKey string) (*conf.Config, error)

Types

type Flow

type Flow struct {
	URL     string            // Local URL the flow is listening on
	LoginCh chan *conf.Config // Successful logins are sent on this
	// contains filtered or unexported fields
}

Flow keeps the state of an ongoing login flow.

func Begin

func Begin() (f *Flow, err error)

Begin begins a new login attempt.

func (*Flow) Close

func (f *Flow) Close()

Close closes the login flow.