Checks whether the given wrapper type matches the this entity.
Register a callback that will be run when the entity is committed.
A function that may be called to unregister the callback.
StaticmatchesChecks 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.
The string entity ID.
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.
Create a new entity of the given type.
This can be used to create a new Entity for any type that implements
EntityWrapper.
const roomy = await Roomy.init(peer, catalogId);
const space = roomy.create(Space);
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.
Open an existing Entity using it's ID.
You provide an EntityWrapper type like Space or Message
that will be wrapped around the entity.
Instantiate from from a Peer and an Entity.
This an other EntityWrapper types simply provide convenient accessors on top of the underlying entity data.
The underlying Leaf Entity.
The leaf peer instance.
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.
A convenient wrapper around an
Entity.EntityWrapper is the parent of all of the more convenient entity types such as
MessageorSpace.Each subclass will usually add it's own accessors that allow for conveniently modifying the underlying
Entity's component data.You are welcome to extend this type yourself ot add custom convenient entity classes.