SoulFireChat

Generated from the pinned SDK source. Use the matching installation. Each source link points to this baseline.

Compose Effect operations with yield* inside a scoped workflow. Properties expose sub-clients and state.

sendCopy Anchor Link

To public chat. message can't be blank or longer than 256 characters.

send(
  message: string,
  options: ChatMutationOptions = {},
): Effect.Effect<BotActionResult, SoulFireOperationError>

Source

commandCopy Anchor Link

Runs a command; the leading / is optional.

command(
  command: string,
  options: ChatMutationOptions = {},
): Effect.Effect<BotActionResult, SoulFireOperationError>

Source

whisperCopy Anchor Link

Sends /msg <recipient> <message>.

whisper(
  recipient: string,
  message: string,
  options: ChatMutationOptions = {},
): Effect.Effect<BotActionResult, SoulFireOperationError>

Source

completeCopy Anchor Link

Tab-completion suggestions for input (a command if it starts with /) at options.cursor, which defaults to the end of input.

complete(
  input: string,
  options: TabCompleteOptions = {},
): Effect.Effect<TabCompleteResponse, SoulFireOperationError>

Source

watchCopy Anchor Link

Chat events matching matcher, as they arrive, until the caller stops iterating. A string matches as a substring of the plain text; a RegExp's groups go in captures and groups. options.sources keeps only those sources.

watch(
  matcher: ChatMatcher,
  options: WatchChatOptions = {},
): Stream.Stream<ChatMatch, SoulFireOperationError>

Source

waitForCopy Anchor Link

The next chat event matching matcher (as in watch). No timeout unless timeoutMs is set.

waitFor(
  matcher: ChatMatcher,
  options: WaitForChatOptions = {},
): Effect.Effect<ChatMatch, SoulFireOperationError>

Source