@roomy-chat/sdk
    Preparing search index...

    Module index

    Welcome to the Roomy SDK!

    This is the core behind the roomy.chat app, and allows you to interact with Roomy spaces, channels, etc. in your own app, or lets you build your own customized chat application.

    Roomy is built on the Leaf SDK, a toolkit for building local-first apps with CRDTs.

    To get started you will need to create a Leaf Peer and then you can start accessing the Roomy API by initializing a Roomy instance.

    Note: Typedoc hides the types from external libraries like Leaf by default. You can show the Leaf types by checking the "External" checkbox in the right sidebar.

    Advanced

    components
    HasPeer

    Other

    Administered
    Announcement
    Awareness
    AwarenessWasm
    Category
    Channel
    Content
    Cursor
    Deletable
    Entity
    EntityId
    EntityList
    EntityWrapper
    Image
    Loro
    LoroCounter
    LoroDoc
    LoroList
    LoroMap
    LoroMovableList
    LoroText
    LoroTree
    LoroTreeNode
    Marker
    Message
    NamedEntity
    Peer
    Reactions
    Roomy
    Space
    Thread
    Timeline
    TimelineItem
    UndoManager
    VersionVector
    WikiPage
    Change
    ImportBlobMetadata
    Listener
    LoroEvent
    LoroEventBatch
    TextUpdateOptions
    AwarenessListener
    ComponentConstructor
    ComponentDef
    ComponentId
    ComponentType
    Container
    ContainerID
    ContainerType
    CounterDiff
    CounterSpan
    Delta
    Diff
    EntityConstructor
    EntityDoc
    EntityIdStr
    ExportMode
    Frontiers
    IdSpan
    ImportStatus
    IntoEntityId
    JsonChange
    JsonContainerID
    JsonDiff
    JsonOp
    JsonOpID
    JsonSchema
    JsonValue
    ListDiff
    ListJsonDiff
    ListOp
    LoroListType
    MapDiff
    MapJsonDiff
    MapOp
    MovableListOp
    NonNullableType
    OpId
    Path
    PeerID
    PeerOpenOptions
    PeerOption
    Side
    StorageConfig
    Subscription
    TextDiff
    TextOp
    TreeDiff
    TreeDiffItem
    TreeID
    TreeNodeJSON
    TreeNodeShallowValue
    TreeNodeValue
    TreeOp
    UndoConfig
    UnknownOp
    Uri
    Value
    VersionVectorDiff
    defaultPeerOpenOptions
    entityComponentsKey
    entityIdPrefix
    decodeFrontiers
    decodeImportBlobMeta
    defComponent
    encodeFrontiers
    getType
    intoEntityId
    isContainer
    isContainerId
    LORO_VERSION
    newContainerID
    newRootContainerID
    run
    setDebug