Type alias DefaultRoot

DefaultRoot: unknown extends AblyObjectsTypes["root"]
    ? LiveMapType
    : AblyObjectsTypes["root"] extends LiveMapType
        ? AblyObjectsTypes["root"]
        : "Provided type definition for the \"root\" object in AblyObjectsTypes is not of an expected LiveMapType"

The default type for the root object for Objects on a channel, based on the globally defined AblyObjectsTypes interface.

  • If no custom types are provided in AblyObjectsTypes, defaults to an untyped root map representation using the LiveMapType interface.
  • If a root type exists in AblyObjectsTypes and conforms to the LiveMapType interface, it is used as the type for the root object.
  • If the provided root type does not match LiveMapType, a type error message is returned.

Generated using TypeDoc