https://github.com/turt2live/matrix-bot-sdk

TypeScript/JavaScript SDK for Matrix bots
https://github.com/turt2live/matrix-bot-sdk

bot hacktoberfest matrix sdk

Last synced: 11 days ago
JSON representation

TypeScript/JavaScript SDK for Matrix bots

• Host: GitHub
• URL: https://github.com/turt2live/matrix-bot-sdk
• Owner: turt2live
• License: mit
• Created: 2018-02-24T19:17:17.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-03-29T10:30:21.000Z (8 months ago)
• Last Synced: 2024-04-14T06:00:09.638Z (7 months ago)
• Topics: bot, hacktoberfest, matrix, sdk
• Language: TypeScript
• Homepage:
• Size: 4 MB
• Stars: 181
• Watchers: 9
• Forks: 67
• Open Issues: 83
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
# matrix-bot-sdk

[![npm version](https://badge.fury.io/js/matrix-bot-sdk.svg)](https://www.npmjs.com/package/matrix-bot-sdk)

TypeScript/JavaScript SDK for Matrix bots. For help and support, visit [#matrix-bot-sdk:t2bot.io](https://matrix.to/#/#matrix-bot-sdk:t2bot.io)

# Documentation

Documentation for the project is available [here](https://turt2live.github.io/matrix-bot-sdk/index.html).

# Matrix version support

The Matrix protocol is [versioned](https://spec.matrix.org/latest/#specification-versions) 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.