TSDocs / JSDocs

Search…
TSDocs / JSDocs
All @mitter-io packages publish generated documentation for their source. The links for the same are listed below:
NOTE @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.
Package
Link to latest
Other versions
@mitter-io/corenpm🔗​
​latest​
​0.5.10, 0.6.32*
@mitter-io/webnpm🔗​
​latest​
​0.5.11-1, 0.6.32*
@mitter-io/nodenpm🔗​
​latest​
​0.5.10, 0.6.32*
@mitter-io/modelsnpm🔗​
​latest​
​0.5.10, 0.6.32*
@mitter-io/react-nativenpm🔗​
​latest​
​0.6.32*
@mitter-io/react-sclnpm🔗​
​latest​
​0.6.32*
 * Latest version
Using the docs
The @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:

The referring type ChannelReferencingMessage can be found in the @mitter-io/models docs for ChannelReferencingMessage.
Usually, you'd get an instance of type or an extension of MitterBase (as defined in @mitter-io/core) by using one of the static methods for your platform:
node.js
web
react-native
1
import { Mitter } from '@mitter-io/node'
2
​
3
const mitter = Mitter.forNode('.. application id',
4
    {
5
        accessKey: '..your access key..',
6
        accessSecret: '..your access secret..'
7
    }
8
)
9
​
Copied!
The documentation for the forNode function can be found here​
1
import { Mitter } from '@mitter-io/web'
2
​
3
const mitter = Mitter.forWeb('.. your application id ..')
4
​
Copied!
The forWeb method is documented here​
1
import { Mitter } from '@mitter-io/react-native'
2
​
3
const mitter = Mitter.forReactNative('.. your application id ..')
4
​
Copied!
The forReactNative method is documented here​
Both the methods as shown above return a platform specific extension of MitterBase which is defined in @mitter-io/core. The exact operations available based on the platform can be referred here:
1.For node.js - MitterBase Reference TSDocs​
2.For web and react-native - Mitter Reference TSDocs​
Specific clients can be fetched on both of these objects using the 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.
For node.js
For Typescript Users
Last modified 2yr ago
Copy link
Contents
Using the docs