https://github.com/deepstreamio/deepstream.io-client-js

The Browser / Node.js Client for deepstream.io
https://github.com/deepstreamio/deepstream.io-client-js

Last synced: 4 months ago
JSON representation

The Browser / Node.js Client for deepstream.io

• Host: GitHub
• URL: https://github.com/deepstreamio/deepstream.io-client-js
• Owner: deepstreamIO
• License: other
• Created: 2014-12-01T06:09:31.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2025-04-27T01:55:47.000Z (11 months ago)
• Last Synced: 2025-05-16T10:07:22.929Z (11 months ago)
• Language: TypeScript
• Homepage:
• Size: 5.65 MB
• Stars: 300
• Watchers: 20
• Forks: 108
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
deepstream.io-client-js

=======================

[![Build Status](https://github.com/deepstreamIO/deepstream.io-client-js/workflows/build/badge.svg)](https://github.com/deepstreamIO/deepstream.io-client-js/actions?query=workflow%3Abuild) [![Coverage Status](https://coveralls.io/repos/github/deepstreamIO/deepstream.io-client-js/badge.svg?branch=master)](https://coveralls.io/github/deepstreamIO/deepstream.io-client-js?branch=master) [![npm version](https://badge.fury.io/js/%40deepstream%2Fclient.svg)](https://badge.fury.io/js/%40deepstream%2Fclient)

The Browser / Node Client for [deepstreamIO](http://deepstreamio.github.io/)

## Documentation

For API documentation see the [documentation page](https://deepstreamio.github.io/docs/docs)!

For tutorials see the [tutorial page](https://deepstreamio.github.io/docs/tutorials/concepts/what-is-deepstream)!

## Usage with Typescript

This repository comes with the Typescript typings bundled. No need to download them separately!

Make sure the `src/client.d.ts` file is accessible to the Typescript compiler. Do this by making sure it's an included file in tsconfig.json by adding a `typeRoots` defininition. (Required Typescript 2.0 or higher.)

>  "typeRoots": [

     "./node_modules/deepstream.io-client.js/src/client.d.ts"

    ]

## Install in react-native

For usage in react-native the bundled client available at `dist/bundle/ds.js` must be used. In order to automatically change the main file in package.json to the bundle file install as: `DEEPSTREAM_ENV=react-native npm install @deepstream/client`. Also the metro bundler must be configured. Check the [documentation](https://deepstreamio.github.io/docs/tutorials/integrations/mobile/react-native) for more details