Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/typescriptlibs/tsl-mastodon-api
TypeScript Library for the Mastodon API
https://github.com/typescriptlibs/tsl-mastodon-api
mastodon typescript
Last synced: 2 months ago
JSON representation
TypeScript Library for the Mastodon API
- Host: GitHub
- URL: https://github.com/typescriptlibs/tsl-mastodon-api
- Owner: typescriptlibs
- License: mit
- Created: 2022-11-06T14:28:31.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-20T20:16:50.000Z (8 months ago)
- Last Synced: 2024-05-23T04:37:44.699Z (7 months ago)
- Topics: mastodon, typescript
- Language: TypeScript
- Homepage: https://typescriptlibs.org/tsl-mastodon-api
- Size: 1010 KB
- Stars: 13
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Security: SECURITY.md
- Authors: AUTHORS.md
Awesome Lists containing this project
README
TypeScript Library for the Mastodon API
=======================================
TypeScript library to access a Mastodon server from front-end or back-end environments.
[](https://github.com/typescriptlibs/tsl-mastodon-api/actions/workflows/codeql.yml)
[](https://github.com/typescriptlibs/tsl-mastodon-api/actions/workflows/node.js.yml)
[](https://www.npmjs.com/package/tsl-mastodon-api)
[](https://github.com/typescriptlibs/tsl-mastodon-api/blob/main/LICENSE.md)
Installation
------------
Run the following command for client/server or server-only projects:
```Shell
npm install tsl-mastodon-api
```
Run the following command for client-only projects:
```Shell
npm install tsl-mastodon-api --omit=optional
```
Access Token
------------
You need an access token for communication with a Mastodon server.
1. Open your Mastodon website and go to the profile settings of the account.
2. In the profile settings open the section 'Development'.
3. Create a new application and use the related access token.
Or you can use the `OAuth.createApp` function (import `tsl-mastodon-api/lib/OAuth.js`).
Examples
--------
```TypeScript
import * as Mastodon from 'tsl-mastodon-api';
async function postHelloWorld(): Promise {
// create the API instance
const mastodon = new Mastodon.API({
access_token: 'ABC',
api_url: 'https://mastodon.example/api/v1/'
});
// expect client / server errors
try {
const media = await mastodon.postMediaAttachment(
{ file: await Mastodon.Utilities.fileFrom('animation.gif') },
true
);
const result = await mastodon.postStatus({
media_ids: [media.json.id],
sensitive: true,
spoiler_text: 'Hello',
status: 'World'
});
console.log(JSON.stringify(result));
}
catch (error) {
console.error(error);
}
}
postHelloWorld();
```
API Overview
------------
The following snippets show an excerpt of the API.
```TypeScript
API(config)
API.delay()
API.search(search)
API.getAccount()
API.getAnnouncements(queryParameters?)
API.getListAccounts(listID, queryParameters?)
API.getMediaAttachment(mediaAttachmentID, awaitProcessing)
API.getNotifications()
API.getStatusesOfPublic(queryParameters?)
API.postDismissAnnouncement(announcementID)
API.postDismissNotification(notificationID)
API.postListAccounts(listID, listAccounts)
API.postMediaAttachment(mediaAttachment, awaitProcessing)
API.postPollVote(pollID, pollVote)
API.postStatus(status)
API.putAnnouncementReaction(announcementID, emojiName)
API.putMediaAttachmentUpdate(mediaAttachmentID, mediaAttachmentUpdate)
API.deleteAnnouncementReaction(announcementID, emojiName)
API.deleteListAccounts(listID, listAccounts)
API.deleteNotification(notificationID)
API.deleteStatus(statusID)
```
```TypeScript
JSON.isAccount(json)
JSON.isAnnouncement(json)
JSON.isList(json)
JSON.isMediaAttachment(json)
JSON.isNotification(json)
JSON.isStatus(json)
JSON.isStreamData(json)
```
```TypeScript
REST(config)
REST.delete(path, params?)
REST.fetch(method, path, params?)
REST.get(path, params?)
REST.patch(path, params?)
REST.post(path, params?)
REST.put(path, params?)
```
Optional with import of `tsl-mastodon-api/lib/OAuth.js`:
```TypeScript
OAuth.createApp(apiURL, appName, redirectURI?, scopes?, website?)
OAuth.getAccessToken(baseURL, clientId, clientSecret, authorizationCode, redirectUri?)
OAuth.getAuthorizationUrl(baseURL, clientId, clientSecret, redirectUri?, scope?)
```
Optional with import of `tsl-mastodon-api/lib/StreamAPI.js`:
```TypeScript
StreamAPI(config)
StreamAPI.off(eventType, eventListener)
StreamAPI.on(eventType, eventListener)
StreamAPI.subscribe(streamType, streamParams?, eventListener?)
StreamAPI.unsubscribe(streamType, streamParams?, eventListener?)
```
Links
-----
* [github.com/typescriptlibs/tsl-mastodon-api](https://github.com/typescriptlibs/tsl-mastodon-api/releases)
* [npmjs.com/package/tsl-mastodon-api](https://www.npmjs.com/package/tsl-mastodon-api)
* [typescriptlibs.org](https://typescriptlibs.org/)