mitter.io
  • Welcome
  • Migrating from cloud to on-prem
  • Get mitter.io
    • Custom configuration
  • Getting started
    • Build Your First Android App
      • Setup
      • Authenticate a User
      • Start a Basic Chat
      • Selective Deliveries
      • Custom Payloads
    • Build Your First iOS App
      • Overview
      • Installation
      • Basic Setup
      • Receive Push Messages
      • Storyboard
      • Channel List
      • Channel Window
    • Build Your First Web App
      • Setting Up Your App
      • Start a Basic Chat
      • Selective Deliveries
    • Build Your First React Native app
  • Platform Reference
    • Introduction
    • Concepts
    • Authorization and Access
    • Calling the APIs
    • Users
    • Channels
      • Channel Streams and Typing Indicators
    • Messages
    • Delivery Endpoints (Push Notifications)
    • Federated Authentication
    • Basic Permissions and Privileges
    • ACLs and Advanced Permission Model
    • Metadata
  • SDKs
    • Android
      • Getting Started
      • Set up FCM
      • Presence and Timeline Events
      • Profiles, Pagination and Locators
      • Using the UI Framework
    • iOS
      • Installation
      • Basic Setup
      • Get the current user details
      • Create a Channel
      • Messaging
      • Push Messages
    • Javascript
      • Using the UI framework (web only)
      • For react-native
      • For node.js
      • TSDocs / JSDocs
      • For Typescript Users
    • Java (Backend)
Powered by GitBook
On this page
  1. SDKs
  2. Javascript

TSDocs / JSDocs

PreviousFor node.jsNextFor Typescript Users

Last updated 6 years ago

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

* 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 call the doc looks like:

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:

import { Mitter } from '@mitter-io/node'

const mitter = Mitter.forNode('.. application id',
    {
        accessKey: '..your access key..',
        accessSecret: '..your access secret..'
    }
)
import { Mitter } from '@mitter-io/web'

const mitter = Mitter.forWeb('.. your application id ..')
import { Mitter } from '@mitter-io/react-native'

const mitter = Mitter.forReactNative('.. your application id ..')

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:

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.

@mitter-io/core

, *

@mitter-io/web

, *

@mitter-io/node

, *

@mitter-io/models

, *

@mitter-io/react-native

*

@mitter-io/react-scl

*

The referring type ChannelReferencingMessage can be found in the @mitter-io/models docs for .

The documentation for the forNode function can be found

The forWeb method is documented

The forReactNative method is documented

For node.js - MitterBase

For web and react-native - Mitter

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 to get a list of clients that are returned by the client set.

ChannelReferencingMessage
here
here
here
Reference TSDocs
Reference TSDocs
this page
npm🔗
latest
0.5.10
0.6.32
npm🔗
latest
0.5.11-1
0.6.32
npm🔗
latest
0.5.10
0.6.32
npm🔗
latest
0.5.10
0.6.32
npm🔗
latest
0.6.32
npm🔗
latest
0.6.32
getMessages