Skip to main content
Home
This release is 5 versions behind 0.3.1 — the latest version of @fedify/botkit. Jump to latest

@fedify/botkit@0.2.0-dev.84+c997c6a6
Built and signed on GitHub Actions

Works with
This package works with Deno
This package works with Deno
JSR Score88%
Downloads25/wk
Published9 months ago (0.2.0-dev.84+c997c6a6)

A framework for creating ActivityPub bots

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.

addCustomEmojis<TEmojiName extends string>(emojis: Readonly<Record<TEmojiName, CustomEmoji>>): Readonly<Record<TEmojiName, DeferredCustomEmoji<TContextData>>>

Defines custom emojis for the bot. The custom emojis are used for rendering the bot's profile and posts. The custom emojis are defined by their names, and the names are used as the keys of the emojis.

Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

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";