npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

matrix-rx

v0.2.3

Published

---

Downloads

13

Readme

Matrix-rx


A Matrix Chat client library based on RxJS.

The reason d'etre of this library is to provide a developer friendly, extensible interface for building on Matrix protocol.

Usage

Installation

yarn install matrix-rx

Init client

import {Matrix} from 'matrix-rx';


const matrix = await Matrix.fromUserAndPassword({
    userId: "@example:matrix.org",
    password: "password",
    server: "matrix.org"
})

Watch the state of the room (including new messages)

import {AugmentedRoomData, AggregatedEvent} from 'matrix-rx'

matrix.room("room_id").subscribe((room: AugmentedRoomData) => {
    // do things with room

    console.log(room.name);

    /**
     * Each message is an Observable in it's own right.
     * It aggregates event relations and emits a new value with the aggregate state
     *
     * E.g. when message is edited or gets reactions, you'll automatically get
     * notified with the new aggregated value
     *
     * */
    room.messages.forEach(messageSubject => {
        messageSubject.subscribe((message: AggregatedEvent) => {
            // do things with message
            console.log(message.content.body);
        })
    })
})

Watch new messages in the room starting from EventId

If you don't care about the state of the room and just want to get notified about new events and updates to events:

matrix.room("room_id", "since eventId").watchEventValues()
    .pipe(filter(it => it.type === 'm.room.message'))
    .subscribe((it: AggregatedEvent) => {
        console.log(it.content.body)
    })

Lower level methods

import {SyncResponse} from 'matrix-rx'

matrix.sync().subscribe((syncResponse: SyncResponse) => {
    // if you just want to subscribe to the response of calling /sync indefinitely
})

React components

These should really be split into a separate package, but I'm waiting to do that when people actually complain about it

The components use Chackra UI for styling & theming.

Example usages

  • You can see me using the above code in the context of the React app in the src/DemoApp.
  • Embed Matrix which allows you to embed Matrix rooms in your website. Is also based on a thin wrapper around this library.

This is currently very much dev focused and not trying to be a full-fledged Matrix client.
That said you can try the current version of the client assembled from those React components at https://matrix-rx.netlify.app