EmitHandle · pyoltra

La referencia de la API está disponible solo en inglés por ahora.

The result of an `emit()` — settles when this event's effects finish. State is already committed when this is returned; the handle tracks only the asynchronous effect phase.

Constructor

`constructor`

Initialize self. See help(type(self)) for accurate signature.

signature

new(event_id, committed, _effects): None

Initialize self. See help(type(self)) for accurate signature.

Parameters

Name	Type	Description
`event_id`	`str`

Name	Type	Description
`committed`	`bool`

Name	Type	Description
`_effects`	`Future<None>`

Returns

None

Properties

Name	Type	Description
`committed`	`bool`	Whether the event passed middleware and ran reducers.
`effects_done`	`bool`	Whether this event's effects have finished.
`event_id`	`str`	The emitted event's id.

Methods

`wait`

Block until this event's effects finish (sync scripts).

signature

wait(timeout?): None

Block until this event's effects finish (sync scripts).

Parameters

Name	Type	Description
`timeout`?	`float \| None`	Optional seconds to wait before raising `concurrent.futures.TimeoutError`.

Returns

None