engine

Documentation

Index

• func NewConfig(disableWebhooks bool, webhookMocks []*flows.WebhookMock, ...) flows.EngineConfig
• func NewDefaultConfig() flows.EngineConfig
• func NewEmptySprint() flows.Sprint
• func NewSession(assets flows.SessionAssets, engineConfig flows.EngineConfig, ...) flows.Session
• func NewSessionAssets(source assets.AssetSource) (flows.SessionAssets, error)
• func NewSprint(modifiers []flows.Modifier, events []flows.Event) flows.Sprint
• func ReadConfig(data json.RawMessage, base flows.EngineConfig) (flows.EngineConfig, error)
• func ReadSession(sessionAssets flows.SessionAssets, engineConfig flows.EngineConfig, ...) (flows.Session, error)

Functions

func NewConfig

func NewConfig(disableWebhooks bool, webhookMocks []*flows.WebhookMock, maxWebhookResponseBytes int) flows.EngineConfig

NewConfig returns a new engine configuration

func NewDefaultConfig

func NewDefaultConfig() flows.EngineConfig

NewDefaultConfig returns the default engine configuration

func NewEmptySprint

func NewEmptySprint() flows.Sprint

NewEmptySprint creates a new sprint

func NewSession

func NewSession(assets flows.SessionAssets, engineConfig flows.EngineConfig, httpClient *utils.HTTPClient) flows.Session

NewSession creates a new session

func NewSessionAssets

func NewSessionAssets(source assets.AssetSource) (flows.SessionAssets, error)

NewSessionAssets creates a new session assets instance with the provided base URLs

func NewSprint

func NewSprint(modifiers []flows.Modifier, events []flows.Event) flows.Sprint

NewSprint creates a new sprint with the passed in modifiers and events

func ReadConfig

func ReadConfig(data json.RawMessage, base flows.EngineConfig) (flows.EngineConfig, error)

ReadConfig reads an engine configuration from the given JSON, using the provided config as a base

func ReadSession

func ReadSession(sessionAssets flows.SessionAssets, engineConfig flows.EngineConfig, httpClient *utils.HTTPClient, data json.RawMessage, missing assets.MissingCallback) (flows.Session, error)

ReadSession decodes a session from the passed in JSON