ygleam - v0.8.0

ygleam/y

Types

AbstractType

</> 
pub type AbstractType

Array

</> 
pub type Array

Doc

</> 
pub type Doc

Map

</> 
pub type Map

Text

</> 
pub type Text

Transaction

</> 
pub type Transaction

Value

</>

The Value type represents the JavaScript types Yjs can hold:

  • null
  • String
  • Boolean
  • Number
  • Uint8Array
  • Array
  • Object<String, Value>
  • Any Yjs type
pub type Value

XmlElement

</> 
pub type XmlElement

XmlFragment

</> 
pub type XmlFragment

Functions

array

</> 
pub fn array(input: Array) -> Value

Encodes a Yjs Array to a y.Value

bit_array

</> 
pub fn bit_array(input: BitArray) -> Value

Encodes a BitArray to a y.Value

bool

</> 
pub fn bool(input: Bool) -> Value

Encodes a Bool to a y.Value

dict

</> 
pub fn dict(
  dict: Dict(a, b),
  keys: fn(a) -> String,
  values: fn(b) -> Value,
) -> Value

Encode a Dict into a JSON object using the supplied functions to encode the keys and the values respectively.

float

</> 
pub fn float(input: Float) -> Value

Encodes a Float to a y.Value

from_json

</> 
pub fn from_json(from: Json) -> Value

int

</> 
pub fn int(input: Int) -> Value

Encodes an Int to a y.Value

js_array

</> 
pub fn js_array(
  from entries: List(a),
  of inner_type: fn(a) -> Value,
) -> Value

Encode a list into a JS array.

map

</> 
pub fn map(input: Map) -> Value

Encodes a Yjs Map to a y.Value

null

</> 
pub fn null() -> Value

Creates a null y.Value

nullable

</> 
pub fn nullable(
  from input: Option(a),
  of inner_type: fn(a) -> Value,
) -> Value

Encodes an optional value into a y.Value, using null if None

object

</> 
pub fn object(entries: List(#(String, Value))) -> Value

Encode a list of key-value pairs into a JSON object.

preprocessed_js_array

</> 
pub fn preprocessed_js_array(from: List(Value)) -> Value

string

</> 
pub fn string(input: String) -> Value

Encodes a String to a y.Value

text

</> 
pub fn text(input: Text) -> Value

Encodes a Yjs Text to a y.Value

xml_element

</> 
pub fn xml_element(input: XmlElement) -> Value

Encodes a Yjs XmlElement to a y.Value

xml_fragment

</> 
pub fn xml_fragment(input: XmlFragment) -> Value

Encodes a Yjs XmlFragment to a y.Value

✨ Search Document