TauClient

This is a library to help you connect to an instance of TAU from a JavaScript based project

Getting Started

1. Run npm i tau-js-client rxjs

   If using in a Node.js app npm i ws

2. Add the following to your code

   import { filter } from 'rxjs';
   import WebSocket from 'ws'; //if using in Node.js
   import tauClient from 'tau-js-client';
   const { getTauMessages, TauChatMessage } = tauClient;

3. Create a config object variable with the needed options shown below

   const config = {
     domain: '<your TAU server domain (without protocol)>',
     port: '<your TAU server port (probably 443 if https)>',
     token: '<your TAU server token>',
     messages: true,
     events: true,
     WebSocketCtor: WebSocket,
   };

4. Pass in that config to getTauMessages(config); and assign to a variable

   const client = getTauMessages(config);

5. Then using observable patterns you can pipe to filter on specific events and then subscribe to them to execute a function when that event triggers. Here is an example to listen for chat messages:

   const chatMessages = client
     .pipe(filter((x) => x instanceof TauChatMessage))
     .subscribe((x) => console.log(`${x.tags.displayName}: ${x.messageText}`));

This project was generated using Nx.

🔎 Smart, Fast and Extensible Build System

Quick Start & Documentation

Nx Documentation

10-minute video showing all Nx features

Interactive Tutorial

Adding capabilities to your workspace

Nx supports many plugins which add capabilities for developing different types of applications and different tools.

These capabilities include generating applications, libraries, etc as well as the devtools to test, and build projects as well.

Below are our core plugins:

• Angular
  • ng add @nrwl/angular
• React
  • ng add @nrwl/react
• Web (no framework frontends)
  • ng add @nrwl/web
• Nest
  • ng add @nrwl/nest
• Express
  • ng add @nrwl/express
• Node
  • ng add @nrwl/node

There are also many community plugins you could add.

Generate an application

Run ng g @nrwl/angular:app my-app to generate an application.

You can use any of the plugins above to generate applications as well.

When using Nx, you can create multiple applications and libraries in the same workspace.

Generate a library

Run ng g @nrwl/angular:lib my-lib to generate a library.

You can also use any of the plugins above to generate libraries as well.

Libraries are shareable across libraries and applications. They can be imported from @tau-client/mylib.

Development server

Run ng serve my-app for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Code scaffolding

Run ng g component my-component --project=my-app to generate a new component.

Build

Run ng build my-app to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Running unit tests

Run ng test my-app to execute the unit tests via Jest.

Run nx affected:test to execute the unit tests affected by a change.

Running end-to-end tests

Run ng e2e my-app to execute the end-to-end tests via Cypress.

Run nx affected:e2e to execute the end-to-end tests affected by a change.

Understand your workspace

Run nx graph to see a diagram of the dependencies of your projects.

Further help

Visit the Nx Documentation to learn more.

☁ Nx Cloud

Distributed Computation Caching & Distributed Task Execution

Nx Cloud pairs with Nx in order to enable you to build and test code more rapidly, by up to 10 times. Even teams that are new to Nx can connect to Nx Cloud and start saving time instantly.

Teams using Nx gain the advantage of building full-stack applications with their preferred framework alongside Nx’s advanced code generation and project dependency graph, plus a unified experience for both frontend and backend developers.

Visit Nx Cloud to learn more.