Skip to main content

Built and signed on GitHub Actions

A framework for creating ActivityPub bots

This package works with Deno
This package works with Deno
JSR Score
88%
Published
2 months ago (0.1.1)
interface Bot

A bot that can interact with the ActivityPub network.

Type Parameters

TContextData

Properties

An internal Fedify federation instance. Normally you don't need to access this directly.

The internal identifier for the bot actor. It is used for the actor URI.

An event handler for a follow request to the bot.

An event handler for an unfollow event from the bot.

An event handler invoked when a follow request the bot sent is accepted.

An event handler invoked when a follow request the bot sent is rejected.

An event handler for a message mentioned to the bot.

An event handler for a reply to the bot.

An event handler for a message shown to the bot's timeline. To listen to this event, your bot needs to follow others first.

An event handler for a message shared to the bot. To listen to this event, your bot needs to follow others first.

An event handler for a like of a message.

An event handler for an undoing of a like of a message.

Methods

Gets a new session to control the bot for a specific origin and context data.

Gets a new session to control bot for a specific Fedify context.

fetch(
request: Request,
contextData: TContextData,
): Promise<Response>

The fetch API for handling HTTP requests. You can pass this to an HTTP server (e.g., Deno.serve(), Bun.serve()) to handle incoming requests.

Add Package

deno add jsr:@fedify/botkit

Import symbol

import { type Bot } from "@fedify/botkit/bot";

---- OR ----

Import directly with a jsr specifier

import { type Bot } from "jsr:@fedify/botkit/bot";