Giter Club home page Giter Club logo

typescript-sdk's Introduction

ABANDONED/UNSUPPORTED

Tinode typescript and javascript SDK

This SDK is still under test and it's not released yet. but if you want to use it at this state you can build it yourself for now. this SDK can be used in browser, nodejs and typescript programs and contains needed declarations for each class.

Build

Simply run npm run build. Now you are going to have dist folder containing browser and lib folder.

Usage

Browser

Import the browser script using the html script tag:

<script src="./dist/browser/tinode.js"></script>

Javascript

Import the library using require:

const tinode = require('./dist/lib');

Typescript and typescript based apps like angular

First copy package.json file into dist/lib folder. Then in that folder run npm pack. This will create a package that can be installed using npm or yarn. The created file will be named tinode-sdk-x.y.z.tgz.

Now you can install the package using npm i tinode-sdk-x.y.z.tgz.

To use this package in typescript use import:

import { Tinode } from 'tinode-sdk';

Generate Document

Run this command:

npm run docs

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.