ygleam/awareness

Types

Awareness

pub type Awareness

AwarenessLocalState

</>

pub type AwarenessLocalState =
  List(#(String, y.Value))

AwarenessStates

</>

pub type AwarenessStates =
  dict.Dict(Float, List(#(String, y.Value)))

Values

apply_awareness_update

</>

pub fn apply_awareness_update(
  awareness: Awareness,
  update: BitArray,
  origin: a,
) -> Nil

destroy

</>

pub fn destroy(awareness: Awareness) -> Nil

encode_awareness_update

</>

pub fn encode_awareness_update(
  awareness: Awareness,
  clients: List(Int),
) -> BitArray

get_local_state

</>

pub fn get_local_state(
  awareness: Awareness,
) -> option.Option(List(#(String, y.Value)))

get_states

</>

pub fn get_states(
  awareness: Awareness,
) -> dict.Dict(Float, List(#(String, y.Value)))

modify_awareness_update

</>

pub fn modify_awareness_update(
  update: BitArray,
  modify: fn(a) -> b,
) -> BitArray

new

</>

pub fn new(ydoc: y.Doc) -> Awareness

on_change

</>

pub fn on_change(
  awareness: Awareness,
  cb: fn(
    List(Int),
    List(Int),
    List(Int),
    option.Option(y.Transaction),
  ) -> Nil,
) -> Nil

on_update

</>

pub fn on_update(
  awareness: Awareness,
  cb: fn(
    List(Int),
    List(Int),
    List(Int),
    option.Option(y.Transaction),
  ) -> Nil,
) -> Nil

remove_awareness_states

</>

pub fn remove_awareness_states(
  awareness: Awareness,
  clients: List(Int),
  origin: a,
) -> Nil

set_local_state

</>

pub fn set_local_state(
  awareness: Awareness,
  state: option.Option(List(#(String, y.Value))),
) -> Nil

set_local_state_field

</>

pub fn set_local_state_field(
  awareness: Awareness,
  field: String,
  value: y.Value,
) -> Nil