ygleam - v0.4.0

ygleam/y

Types

AbstractType

</> 
pub type AbstractType

BaseType

</>

The BaseType type represents the basic Javascript types Yjs can hold:

  • String
  • Boolean
  • Number
  • Uint8Array
  • Array
  • Object<String, BaseType>
pub type BaseType

Transaction

</> 
pub type Transaction

YArray

</> 
pub type YArray

YDoc

</> 
pub type YDoc

YMap

</> 
pub type YMap

YText

</> 
pub type YText

YType

</> 
pub type YType {
  AbstractType(value: AbstractType)
  YDoc(value: YDoc)
  YMap(value: YMap)
  YArray(value: YArray)
  YText(value: YText)
  YXmlFragment(value: YXmlFragment)
  YXmlElement(value: YXmlElement)
}

Constructors 

  • AbstractType(value: AbstractType)
  • YDoc(value: YDoc)
  • YMap(value: YMap)
  • YArray(value: YArray)
  • YText(value: YText)
  • YXmlFragment(value: YXmlFragment)
  • YXmlElement(value: YXmlElement)

YValue

</> 
pub type YValue {
  BaseType(value: Dynamic)
  YType(value: YType)
}

Constructors 

  • BaseType(value: Dynamic)
  • YType(value: YType)

YXmlElement

</> 
pub type YXmlElement

YXmlFragment

</> 
pub type YXmlFragment

Functions

array

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

bit_array

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

bool

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

decode

</> 
pub fn decode(
  yvalue: YValue,
  decoder: fn(Dynamic) -> Result(a, List(DecodeError)),
) -> Result(a, List(DecodeError))

float

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

from_gleam_json

</> 
pub fn from_gleam_json(from: Json) -> BaseType

int

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

null

</> 
pub fn null() -> BaseType

nullable

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

object

</> 
pub fn object(input: List(#(String, BaseType))) -> BaseType

preprocessed_array

</> 
pub fn preprocessed_array(from: List(BaseType)) -> BaseType

string

</> 
pub fn string(input: String) -> BaseType
✨ Search Document