JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 5415
  • Score
    100M100P100Q141771F
  • License MIT

TypeScript/JavaScript SDK for Matrix bots and appservices

Package Exports

  • @vector-im/matrix-bot-sdk
  • @vector-im/matrix-bot-sdk/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@vector-im/matrix-bot-sdk) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

matrix-bot-sdk

npm version

TypeScript/JavaScript SDK for Matrix bots. For help and support, visit #matrix-bot-sdk:t2bot.io

Documentation

Documentation for the project is available here.

Matrix version support

The Matrix protocol is versioned to ensure endpoints and functionality can safely rotate in and out of the ecosystem. The bot-sdk will assume it is connected to a homeserver with support for at least one of the last 2 versions, at the time of the bot-sdk's release. This means that if you connect the bot-sdk to a homeserver which is 3 or more Matrix versions out of date, things might not work for you.

It is recommended to update the bot-sdk as frequently as spec releases themselves (or faster) to avoid this situation, and watch the repo for updates in the event a release is delayed.

Note: Currently the bot-sdk does not throw an error if the server appears to be incompatible, however this might change in the future.