Giter VIP home page Giter VIP logo

brunost's Introduction

Brunost (Brown Cheese)

Brunost is a JavaScript library that lets you send messages to various chat services, which is useful for sending notifications to yourself or your team. Oh also, it has a cool name and has minimal dependencies.

Currently supported services are:

  • Matrix

More services will be added in the future. If you have a suggestion for a service, please open an issue and I'll look into it.

Usage

First we need to install the library.

npm install brunost

Then we can use it in our code.

const brunost = require('brunost');

brunost.sendMatrixMessage("matrix.org", "token", "roomid", "Hello world!");

What about TypeScript? No problem!

import { sendMatrixMessage } from 'brunost';

sendMatrixMessage("matrix.org", "token", "roomid", "Hello world!");

API

sendMatrixMessage

sendMatrixMessage(server: string, token: string, roomid: string, message: string): Promise<void>

Sends a message to a Matrix room. Room ID can be found in the room settings (do not use room alias, aka #room:server.org).

brunost's People

Contributors

pistasjis avatar

Watchers

 avatar

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.