Presto.Core.Types.Language.Flow

data Authorization

Constructors

• RegistrationTokens RegTokens

type UIResult s = Either Error s

type APIResult s = Either ErrorResponse s

data Store

Constructors

• LocalStore
• InMemoryStore

newtype Control s

Constructors

• Control (AVar s)

data ErrorHandler s

Constructors

• ThrowError String
• ReturnResult s

data FlowMethodF a s

Algebra of the Flow free language.

Constructors

• RunUI (Interaction (UIResult s)) (UIResult s -> a)
• ForkUI (Interaction (UIResult s)) a
• CallAPI (Interaction (APIResult s)) (APIResult s -> a)
• Get Store Key (Maybe String -> a)
• Set Store Key String a
• Fork (Flow s) (Control s -> a)
• DoAff (forall eff. AppFlow eff s) (s -> a)
• Await (Control s) (s -> a)
• Delay Milliseconds a
• OneOf (Array (Flow s)) (s -> a)
• HandleError (Flow (ErrorHandler s)) (s -> a)
• CheckPermissions (Array Permission) (PermissionStatus -> a)
• TakePermissions (Array Permission) (Array PermissionResponse -> a)

type FlowMethod s a = FlowMethodF a s

newtype FlowWrapper a

Constructors

• FlowWrapper (Exists (FlowMethodF a))

type Flow a = Free FlowWrapper a

Free monadic language for making flows.

wrap :: forall s a. FlowMethodF a s -> Flow a

FlowWrapper for existential type.

getS :: Key -> Flow (Maybe String)

Gets some string from state by key

setS :: Key -> String -> Flow Unit

Puts a string value into state using key.

loadS :: Key -> Flow (Maybe String)

Gets some string from localStorage by key

saveS :: Key -> String -> Flow Unit

Puts a string value into the localStorage using key.

withError :: forall s err. (err -> String) -> Flow (Either err s) -> Flow s

Converts error to string and throws at runtime or returns result.

suppress :: forall s err. Flow (Either err s) -> Flow Unit

Supresses error.

throwErr :: forall a. String -> Flow a

Throws error.

runUI' :: forall b a. Interact Error a b => a -> Flow (UIResult b)

Runs UI and returns result of user's interaction with a screen.

runUI :: forall b a. Interact Error a b => a -> Flow b

Runs UI and returns result of user's interaction with a screen. Handles error in runtime.

forkUI :: forall b a. Interact Error a b => a -> Flow Unit

Runs UI async, doesn't return anything useful. Handles error in runtime.

showUI :: forall b a. Interact Error a b => a -> Flow Unit

Runs UI and doesn't return anything useful (equivalent to void <<< runUI). Handles error in runtime.

evalUI :: forall s b a. Interact Error a b => a -> (b -> Either Error s) -> Flow s

Runs UI with a custom converter Handles error in runtime.

callAPI :: forall b a. Encode a => Decode b => RestEndpoint a b => Headers -> a -> Flow (APIResult b)

Call API being authorized.

get :: forall s. Serializable s => Key -> Flow (Maybe s)

Gets some data from state and deserializes to s if possible.

set :: forall s. Serializable s => Key -> s -> Flow Unit

Serializes a value and puts it into the state.

fork :: forall s. Flow s -> Flow (Control s)

Forks a flow and returns a control structure for getting results back (like Future).

launch :: Flow Unit -> Flow (Control Unit)

Forks a flow and returns a void control structure.

doAff :: forall s. (forall eff. AppFlow eff s) -> Flow s

Runs any Aff as part of the flow

await :: forall s. Control s -> Flow s

Awaits result from a forked flow.

await' :: forall s. Control s -> Flow Unit

Awaits a forked flow to be completed.

delay :: Milliseconds -> Flow Unit

Delays computation for a given number of milliseconds.

oneOf :: forall s. Array (Flow s) -> Flow s

Executes a set of actions and returns when the first one is done

load :: forall s. Serializable s => Key -> Flow (Maybe s)

Gets some data from local storage and deserializes to s if possible.

save :: forall s. Serializable s => Key -> s -> Flow Unit

Serializes a value and puts it into the local storage.

checkPermissions :: Array Permission -> Flow PermissionStatus

Checks if permissions granted.

takePermissions :: Array Permission -> Flow (Array PermissionResponse)

Tries to aquire permissions.