@fedify/botkit@0.3.1

Built and signed on GitHub Actions

Built and signed on GitHub Actions

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

An event handler for a follow request to the bot.

An event handler for a like of a message.

An event handler for a message mentioned 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 quote of the bot's message.

An event handler for an emoji reaction to a message.

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

An event handler for a reply to the bot.

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

An event handler for undoing an emoji reaction to a message.

An event handler for an unfollow event from the bot.

An event handler for undoing a like of a message.

An event handler for a vote in a poll. This event is only triggered when the bot is the author of the poll, and the vote is made by another actor. Note that if the poll allows multiple selections, this event is triggered multiple times, once for each option selected by the actor.

A bot that can interact with the ActivityPub network.

A specialized Bot tpe that doesn't require context data.

Creates a Bot instance.

Options for creating a bot.

Options for the web pages of the bot.

A definition of a custom emoji. It can be either a remote image URL or a local image file.

The common interface for defining custom emojis.

The interface for defining custom emojis from a local image file.

The interface for defining custom emojis from a remote image URL.

A deferred Emoji (provided by Fedify), which is a function that takes a Session and returns an Emoji. This is useful for creating emojis that depend on the session data.

A branded type for a single emoji character (more exactly, a single Unicode grapheme cluster of emoji). This is used to represent a single emoji in a string format. It is not a full-fledged emoji object, but rather a string that is guaranteed to be a single emoji.

A tagged template literal function that creates an Emoji from a string. It is a simple wrapper around the String.raw function, but it also checks if the resulting string is a valid emoji.

A type guard that checks if a value is a single emoji character.

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

An event handler for a follow request to the bot.

An event handler for a like of a message.

An event handler for a message mentioned 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 quote of the bot's message.

An event handler for an emoji reaction to a message.

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

An event handler for a reply to the bot.

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

An event handler for undoing an emoji reaction to a message.

An event handler for an unfollow event from the bot.

An event handler for undoing a like of a message.

An event handler for a vote in a poll. This event is only triggered when the bot is the author of the poll, and the vote is made by another actor. Note that if the poll allows multiple selections, this event is triggered multiple times, once for each option selected by the actor.

A follow request to the bot.

An authorized message in the ActivityPub network. Usually it is a message published by the bot itself.

An authorized shared message in the ActivityPub network. Usually it is a message shared by the bot itself.

A message in the ActivityPub network. It is a thin wrapper around a Fedify object: an Article, a ChatMessage, a Note, or a Question.

A possible message class.

Options for sharing a message.

The visibility of a message.

A shared message in the ActivityPub network. It is a thin wrapper around an Announce, which is a Fedify object.

An interface representing a poll.

An interface representing a vote in a poll. Note that if the poll allows multiple selections, the options are represented as multiple Vote objects, each with a single option.

An authorized like of a message. Usually it is a like that the bot itself made.

An authorized emoji reaction to a message. Usually it is a reaction that the bot itself made.

A like of a message. It is a thin wrapper around a Like, which is a Fedify object.

An emoji reaction to a message. It is a thin wrapper around an EmojiReact, which is a Fedify object.

A repository for storing bot data using a key-value store.

The prefixes for key-value store keys used by the bot.

A repository decorator that adds an in-memory cache layer on top of another repository. This is useful for improving performance by reducing the number of accesses to the underlying persistent storage, but it increases memory usage. The cache is not persistent and will be lost when the process exits.

A repository for storing bot data in memory. This repository is not persistent and is only suitable for testing or development.

A repository for storing bot data.

Options for getting followers from the repository.

Options for getting messages from the repository.

A UUID (universally unique identifier).

A session to control the bot.

Options for getting messages from the bot's outbox.

Options for publishing a message.

Options for publishing a message with a specific class.

Options for publishing a question with a poll.

Applies <code> tag to a text. You can use this function to create a CodeText tree.

A text tree that renders a inline code. You normally don't need to instantiate this directly; use the code function instead.

Renders a custom emoji. You can use this function to create a CustomEmojiText tree.

A text tree that renders a custom emoji. You normally don't need to instantiate this directly; use the customEmoji function instead.

Applies <em> tag to a text. You can use this function to create an EmText tree.

A text tree that renders an <em> text. You normally don't need to instantiate this directly; use the em function instead.

Creates a hashtag. You can use this function to create a HashtagText tree.

A text tree that renders a hashtag. You normally don't need to instantiate this directly; use the hashtag function instead.

Checks if a value is a Text tree.

Creates a link to the given href with the label. You can use this function to create a LinkText tree.

A text tree that renders a link. You normally don't need to instantiate this directly; use the link function instead.

Renders a Markdown text. You can use this function to create a MarkdownText tree. The mentions in the Markdown text will be rendered as links unless the mentions option is set to false.

A text tree that renders a Markdown text. You normally don't need to instantiate this directly; use the markdown function instead.

The options for rendering a Markdown text.

Mentions an actor by its fediverse handle. You can use this function to create a MentionText tree. The label of the mention will be the same as the handle.

Checks if a given actor is mentioned in a text.

A text tree that renders a mention. You normally don't need to instantiate this directly; use the mention function instead.

A text tree that renders a plain text. You normally don't need to instantiate this directly; use the plainText function instead.

A function that creates a PlainText tree. It only does two simple things:

Applies <strong> tag to a text. You can use this function to create a StrongText tree.

A text tree that renders a <strong> text. You normally don't need to instantiate this directly; use the strong function instead.

A text tree that renders a template string with values. You normally don't need to instantiate this directly; use the text function instead.

A tree structure representing a text with formatting. It does not only render the text but also extract tags (e.g., mentions) from it.

A template string tag that creates a Text tree.