lightspeed/event

Typed event decoders for browser-originated event payloads.

Types

DecodeError

Typed event decoder errors.

pub type DecodeError {
  UnexpectedEvent(expected: String, actual: String)
  InvalidForm(form.FormError)
}

Constructors

UnexpectedEvent(expected: String, actual: String)

```
InvalidForm(form.FormError)
```

InboundEvent

Browser-originated inbound event frame payload.

pub type InboundEvent {
  InboundEvent(name: String, payload: String)
}

Constructors

InboundEvent(name: String, payload: String)

Values

decode_form

pub fn decode_form(
  event: InboundEvent,
  expected_name: String,
  with: fn(form.FormData) -> Result(msg, form.FormError),
) -> Result(msg, DecodeError)

Decode an event payload through form bindings.

decode_unit

pub fn decode_unit(
  event: InboundEvent,
  expected_name: String,
  message: msg,
) -> Result(msg, DecodeError)

Decode an event with no payload requirement.

error_to_string

pub fn error_to_string(error: DecodeError) -> String

Convert decoder errors to stable log strings.

inbound

pub fn inbound(name: String, payload: String) -> InboundEvent

Build an inbound event.

name

pub fn name(event: InboundEvent) -> String

Event name.

payload

pub fn payload(event: InboundEvent) -> String

Raw payload string.