gossamer/custom_event

Types

CustomEvent

An Event with a custom detail payload that can be dispatched from application code.

pub type CustomEvent

Fields

</>

The data carried by a CustomEvent. Inherited Event properties (type, bubbles, cancelable, etc.) are reachable via to_event and the functions in gossamer/event.

pub type Fields {
  Fields(detail: option.Option(dynamic.Dynamic))
}

Constructors

```
Fields(detail: option.Option(dynamic.Dynamic))
```
Arguments

detail

The detail payload, or None if none was provided.

Values

detail

</>

pub fn detail(
  of event: CustomEvent,
) -> Result(dynamic.Dynamic, Nil)

Returns the detail value associated with the event, or an error if none was provided.

new

</>

pub fn new(type_: String) -> CustomEvent

Creates a new CustomEvent with the given type.

new_with_detail

</>

pub fn new_with_detail(
  type_: String,
  detail detail: a,
) -> CustomEvent

Creates a new CustomEvent with the given type and detail value.

to_event

</>

pub fn to_event(event: CustomEvent) -> event.Event

Converts a CustomEvent to a base Event for use with functions in gossamer/event.

to_fields

</>

pub fn to_fields(event: CustomEvent) -> Fields

Constructors

Arguments