Options
All
  • Public
  • Public/Protected
  • All
Menu

node-nakiri

Index

Enumerations

Classes

Interfaces

Type aliases

Type aliases

Blacklist

Blacklist: YouTubeVideo | YouTubeChannel | LinkPattern | DiscordGuild | Phrase

Specifies one of the many blacklist types.

BlacklistEntryKind

BlacklistEntryKind: "regex" | "substring"

Specifies the kind of a blacklisted entry.

BlacklistType

BlacklistType: "youtubeVideoID" | "youtubeChannelID" | "linkPattern" | "discordGuildID" | "phrase"

Specifies the name of the blacklist's type.

MessageContext

MessageContext<T>: T & { channelId?: string; guildId?: string; messageId?: string; userId?: string }

This is an object that will be passed to the analysis gateway request to include additional information about the message that triggered the analysis. When the analysis result arrives, it will contain this data. You can technically pass anything to this object, since it will just be passed back and forth.

property

{string} guildId - The ID of the guild the message was sent in.

property

{string} channelId - The ID of the channel the message was sent in.

property

{string} messageId - The ID of the message that triggered the analysis.

property

{string} userId - The ID of the author of the message that triggered the analysis.

Type parameters

  • T = any

NakiriHTTPGetDiscordGuildsResponse

NakiriHTTPGetDiscordGuildsResponse: NakiriHTTPGetBlacklistResponse<"discordGuilds", DiscordGuild>

NakiriHTTPGetLinkPatternsResponse

NakiriHTTPGetLinkPatternsResponse: NakiriHTTPGetBlacklistResponse<"patterns", LinkPattern>

NakiriHTTPGetPhrasesResponse

NakiriHTTPGetPhrasesResponse: NakiriHTTPGetBlacklistResponse<"phrases", YouTubeVideo>

NakiriHTTPGetYouTubeChannelsResponse

NakiriHTTPGetYouTubeChannelsResponse: NakiriHTTPGetBlacklistResponse<"channelIDs", YouTubeChannel>

NakiriHTTPGetYouTubeVideosResponse

NakiriHTTPGetYouTubeVideosResponse: NakiriHTTPGetBlacklistResponse<"videoIDs", YouTubeVideo>

Generated using TypeDoc