• Preparing search index...
  • The search index is not available
RevKit Documentation
Settings

Member Visibility

Theme

Modules

  • RevKit Documentation
    • revkit
      ![RevKit logo](https://raw.githubusercontent.com/Revolt-Unofficial-Clients/revkit/master/revkit-header.png)
      • API
    • revkit/commandeer
      ![RevKit logo](https://raw.githubusercontent.com/Revolt-Unofficial-Clients/revkit/master/revkit-header.png)
    • revkit/voice
      ![RevKit logo](https://raw.githubusercontent.com/Revolt-Unofficial-Clients/revkit/master/revkit-header.png)
  • APIAttachment
  • APIChannel
  • APIEmbed
  • APIEmoji
  • APIInvite
  • APIMember
  • APIMessage
  • APIServer
  • APIUser
  • AutocompleteType
  • ChannelType
  • MarkdownTimestampTypes
  • Permissions
    Permissions against servers/channels.
  • RelationshipStatus
    Relationship to other users.
  • RevoltBadges
  • RevoltServerFlags
  • RevoltUserFlags
  • SystemMessageType
    The different types of system messages.
  • UserPermissions
    Permissions against users.
  • Attachment
  • AuthSession
  • BaseEmbed
  • BaseFlags
  • BaseMessage
  • BaseObject
  • Category
  • Channel
  • ChannelManager
  • Client
  • DMChannel
  • DefaultEmoji
  • Embed
  • EmbedBuilder
  • EmbedMedia
  • EmbedWeb
  • Emoji
  • EmojiManager
  • GlobalInvite
  • GroupDMChannel
  • Member
  • MemberManager
  • Message
  • MessageManager
  • MiniEmitter
  • MiniMapEmitter
  • PermissionFlags
  • Role
  • RoleManager
  • SavedMessagesChannel
  • Server
  • ServerChannel
  • ServerFlags
  • ServerInvite
  • ServerManager
  • SystemMessage
  • TextChannel
  • UnreadManager
  • User
  • UserBadges
  • UserFlags
  • UserManager
  • UserPermissionFlags
  • VoiceChannel
  • WebSocketClient
  • AutocompleteItem
  • AutocompleteResult
  • AutocompleteTabResult
  • AutumnConfig
  • AutumnConfigTag
  • ClientEvents
    The various events a client can emit.
  • ClientOptions
    Options for initializing a new client.
  • ClientSession
    Represents a currently logged in session.
  • CustomBadge
  • GlobalInviteServer
  • JanuaryConfig
  • MessageOptions
  • PermissionOverride
  • ThemeSettings
  • UserMutuals
  • UserProfile
  • VortexConfig
  • APICategory
    Type compatibility with the Managers.
  • APIGlobalInvite
    Type compatibility with the Managers.
  • APIRole
    Type compatibility with the Managers.
  • APISessionInfo
    Adds token to session.
  • APIUnread
    Type compatibility with the Managers.
  • AnyEmoji
    Utility type. One of `DefaultEmoji` or `Emoji`.
  • AttachmentArgs
  • AttachmentBucket
  • ChannelUnreadChecker
  • ClientboundNotification
    Packets that come from the server.
  • EmojiPacks
  • MessageEditPayload
  • MessagePayload
  • MiniEmitterCallback
  • ReadyPacket
    Pcket received to initialize the client.
  • ServerUnreadChecker
  • ServerboundNotification
    Packets that are sendable to the server.
  • SystemMessageDetail
  • UserBadge
  • ALLOW_IN_TIMEOUT
    Permissions allowed for a user while in timeout
  • AutocompleteItems
  • CustomBadges
    Custom badges added by users.
  • DEAD_ID
    ID made up of all 0s.
  • DEFAULT_PERMISSION
    Default base permissions for channels
  • DEFAULT_PERMISSION_DIRECT_MESSAGE
    Permissions in direct message channels / default permissions for group DMs
  • DEFAULT_PERMISSION_SAVED_MESSAGES
    Permissions in saved messages channel
  • DEFAULT_PERMISSION_SERVER
    Permissions in server text / voice channel
  • DEFAULT_PERMISSION_VIEW_ONLY
    Default permissions if we can only view
  • DEFAULT_THEME
  • RevoltBadgeData
  • RevoltEmojiDictionary
  • RevoltEmojiLib
  • U32_MAX
    Maximum safe value
  • bitwiseAndEq
  • calculatePermissions
    Calculate permissions against an object. (optionally as a different member)
  • constructMessageEditPayload
  • constructMessagePayload
  • emojiToCodePoint
  • escapeRegex
  • getMarkdownTimestamp
    Converts millisecond time to a markdown timestamp.
  • parseAutocomplete
    Calculates autocomplete for the given input text in the given channel.
  • unicodeEmojiURL
  • RevKit Documentation
  • revkit
  • escapeRegex

Function escapeRegex

  • escapeRegex(str: String): string
  • Parameters

    • str: String

    Returns string

    • Defined in core/src/utils/utils.ts:1