Class Space

createdDate

• get createdDate(): undefined | Date

  Returns undefined | Date

• set createdDate(date: undefined | Date): void

  Parameters

  • date: undefined | Date

  Returns void

description

• get description(): undefined | string

  Returns undefined | string

• set description(description: undefined | string): void

  Parameters

  • description: undefined | string

  Returns void

image

• get image(): undefined | `leaf:${string}`

  Returns undefined | `leaf:${string}`

• set image(value: `leaf:${string}` | { id: `leaf:${string}` }): void

  Parameters

  • value: `leaf:${string}` | { id: `leaf:${string}` }

  Returns void

name

• get name(): string

  Returns string

• set name(name: string): void

  Parameters

  • name: string

  Returns void

softDeleted

• get softDeleted(): boolean

  Returns boolean

• set softDeleted(deleted: boolean): void

  Parameters

  • deleted: boolean

  Returns void

updatedDate

• get updatedDate(): undefined | Date

  Returns undefined | Date

• set updatedDate(date: undefined | Date): void

  Parameters

  • date: undefined | Date

  Returns void

admins

• admins<R>(handler: (admins: LoroMovableList<string>) => R): R

  The user IDs of the admins of this entity.

  Type Parameters

  • R

  Parameters

  • handler: (admins: LoroMovableList<string>) => R

  Returns R

appendAdminsFrom

• appendAdminsFrom(other: Administered): void

  Add all of the admins from another Administered entity to the admins list for this entity.

  Parameters

  • other: Administered

  Returns void

bans

• bans<R>(handler: (bans: LoroMap<{ [id: string]: undefined | boolean }>) => R): R

  The set of user IDs that have been banned from this entity.

  Type Parameters

  • R

  Parameters

  • handler: (bans: LoroMap<{ [id: string]: undefined | boolean }>) => R

  Returns R

forceCast

• forceCast<T extends EntityWrapper>(constructor: EntityConstructor<T>): T

  Type Parameters

  • T extends EntityWrapper

  Parameters

  • constructor: EntityConstructor<T>

  Returns T

handles

• handles<R>(handler: (x: LoroList<string>) => R): R

  Type Parameters

  • R

  Parameters

  • handler: (x: LoroList<string>) => R

  Returns R

matches

• matches<T extends typeof EntityWrapper>(constructor: T): boolean

  Checks whether the given wrapper type matches the this entity.

  Type Parameters

  • T extends typeof EntityWrapper

  Parameters

  • constructor: T

  Returns boolean

subscribe

• subscribe(listener: () => void): () => void

  Register a callback that will be run when the entity is committed.

  Parameters

  • listener: () => void

  Returns () => void

  A function that may be called to unregister the callback.

Staticmatches

• matches(wrapper: EntityWrapper): boolean

  Checks whether the given entity matches this wrapper type.

  The default implementation is to return true for every entity, but some wrappers will override it to check for the existence of certain marker components.

  Parameters

  • wrapper: EntityWrapper

  Returns boolean

id

• get id(): `leaf:${string}`

  The string entity ID.

  Returns `leaf:${string}`

commit

• commit(): void

  Commit any changes made to the entity.

  Important: You must call commit after making changes in order for those changes to be immediately applied, reacted to, and synced to network and/or storage.

  Returns void

create

• create<T extends EntityWrapper>(constructor: EntityConstructor<T>): Promise<T>

  Create a new entity of the given type.

  This can be used to create a new Entity for any type that implements EntityWrapper.

  Example

  const roomy = await Roomy.init(peer, catalogId);
  const space = roomy.create(Space);
  Copy

  Note: This method is inherited from EntityWrapper on all entity types, and it doesn't matter which type you call create() on, they are all equivalent.

  Type Parameters

  • T extends EntityWrapper

  Parameters

  • constructor: EntityConstructor<T>

  Returns Promise<T>

open

• open<T extends EntityWrapper>(
      constructor: EntityConstructor<T>,
      id: IntoEntityId,
  ): Promise<T>

  Open an existing Entity using it's ID.

  You provide an EntityWrapper type like Space or Message that will be wrapped around the entity.

  Type Parameters

  • T extends EntityWrapper

  Parameters

  • constructor: EntityConstructor<T>
  • id: IntoEntityId

  Returns Promise<T>

entity

peer

tryCast

• tryCast<T extends EntityWrapper>(
      constructor: EntityConstructor<T> & typeof EntityWrapper,
  ): undefined | T

  Cast from one EntityWrapper type to another.

  Returns undefined if EntityWrapper#matches returns false for the given constructor type.

  You will not usually need to cast entity types to other ones, but it can be useful in some situations, where you would like to use another EntityWrapper types's accessors.

  Type Parameters

  • T extends EntityWrapper

  Parameters

  • constructor: EntityConstructor<T> & typeof EntityWrapper

  Returns undefined | T