@mitter-io
packages publish generated documentation for their source. The links for the same are listed below:@mitter-io/web
package includes breaking changes that currently render all versions prior to AND including 0.5.10
in a non-working state. Please update your web package to 0.5.11-1
for all dependant packages.@mitter-io/models
contains the shape for all of the objects used across the SDK. When facing a method signature/class definition, any referring types usually can be found in the models
package. For example, in @mitter-io/core
, in the getMessages
call the doc looks like:ChannelReferencingMessage
can be found in the @mitter-io/models
docs for ChannelReferencingMessage
.MitterBase
(as defined in @mitter-io/core
) by using one of the static methods for your platform:MitterBase
which is defined in @mitter-io/core
. The exact operations available based on the platform can be referred here:Mitter.clients()
method which returns a MitterClientSet
from which different clients can fetched for performing mitter.io API calls. You can refer the methods section in this page to get a list of clients that are returned by the client set.NOTE We currently do not automatically hyperlink types across the different packages. We are working on a solution towards this problem and will try to publish the new docs with hyperlinks soon. We apologize for the inconvenience.