Documentation / @zerotal/flow / index / FlowEffects
Interface: FlowEffects
Defined in: flow/src/Component.ts:143
The bag of side effects an action queued (flashes, a redirect, client scripts, events, downloads, a title, and the current error bag). Drained by Component._drainEffects and read by the WebSocket handler to build the response frames sent to the client.
Properties
flashes
flashes:
FlashMessage[]
Defined in: flow/src/Component.ts:144
redirectUrl
redirectUrl:
string|null
Defined in: flow/src/Component.ts:145
shouldRefresh
shouldRefresh:
boolean
Defined in: flow/src/Component.ts:146
scripts
scripts:
string[]
Defined in: flow/src/Component.ts:147
errors
errors:
Record<string,string[]>
Defined in: flow/src/Component.ts:148
events
events:
object[]
Defined in: flow/src/Component.ts:149
name
name:
string
data
data:
Record<string,unknown>
to?
optionalto?:string
self?
optionalself?:boolean
downloads
downloads:
object[]
Defined in: flow/src/Component.ts:150
filename
filename:
string
content
content:
string
mime
mime:
string
title
title:
string|null
Defined in: flow/src/Component.ts:151