Class Placeholder

Constructors

constructor

Properties

placeholderKeys

Methods

apply applyToEmbed match parse parseContext

Constructors

constructor

Properties

Static ReadonlyplaceholderKeys

placeholderKeys: {
    channel: (
        | "type"
        | "createdAt"
        | "createdTimestamp"
        | "id"
        | "partial"
        | "url"
        | "deletable"
        | "manageable"
        | "name"
        | "position"
        | "rawPosition"
        | "viewable"
        | "flags.bitfield"
        | "members.size"
    )[];
    guild: (
        | "createdAt"
        | "createdTimestamp"
        | "id"
        | "icon"
        | "ownerId"
        | "memberCount"
        | "name"
        | "banner"
        | "description"
        | "available"
        | "applicationId"
        | "afkChannelId"
        | "afkTimeout"
        | "maxVideoChannelUsers"
        | "approximateMemberCount"
        | "approximatePresenceCount"
        | "defaultMessageNotifications"
        | "discoverySplash"
        | "explicitContentFilter"
        | "joinedAt"
        | "joinedTimestamp"
        | "large"
        | "maximumMembers"
        | "maximumPresences"
        | "maxStageVideoChannelUsers"
        | "mfaLevel"
        | "preferredLocale"
        | "premiumProgressBarEnabled"
        | "premiumTier"
        | "publicUpdatesChannelId"
        | "rulesChannelId"
        | "safetyAlertsChannelId"
        | "shardId"
        | "systemChannelId"
        | "vanityURLUses"
        | "widgetChannelId"
        | "widgetEnabled"
        | "maximumBitrate"
        | "nsfwLevel"
        | "premiumSubscriptionCount"
        | "splash"
        | "vanityURLCode"
        | "verificationLevel"
        | "features"
        | "nameAcronym"
        | "partnered"
        | "verified"
        | "systemChannelFlags.bitfield"
    )[];
    member: (
        | "id"
        | "partial"
        | "manageable"
        | "avatar"
        | "banner"
        | "pending"
        | "joinedAt"
        | "joinedTimestamp"
        | "bannable"
        | "displayColor"
        | "displayHexColor"
        | "displayName"
        | "communicationDisabledUntil"
        | "communicationDisabledUntilTimestamp"
        | "kickable"
        | "moderatable"
        | "nickname"
        | "premiumSince"
        | "premiumSinceTimestamp"
        | "flags.bitfield"
        | "permissions.bitfield"
        | "voice.id"
        | "voice.deaf"
        | "voice.mute"
        | "voice.channelId"
        | "voice.selfDeaf"
        | "voice.selfMute"
        | "voice.serverDeaf"
        | "voice.serverMute"
        | "voice.sessionId"
        | "voice.streaming"
        | "voice.selfVideo"
        | "voice.suppress"
        | "voice.requestToSpeakTimestamp"
    )[];
    user: (
        | "createdAt"
        | "createdTimestamp"
        | "id"
        | "partial"
        | "avatar"
        | "banner"
        | "username"
        | "system"
        | "displayName"
        | "accentColor"
        | "avatarDecoration"
        | "bot"
        | "discriminator"
        | "defaultAvatarURL"
        | "globalName"
        | "hexAccentColor"
        | "tag"
        | "flags.bitfield"
        | "dmChannel.id"
        | "avatarDecorationData.skuId"
        | "avatarDecorationData.asset"
    )[];
} = placeholderKeys

Methods

Staticapply

  • apply(
        str: string,
        placeholders: [string, string][] | ContextPlaceholders,
    ): string

    Parameters

    • str: string
    • placeholders: [string, string][] | ContextPlaceholders

    Returns string

StaticapplyToEmbed

  • applyToEmbed(
        embed: EmbedBuilder,
        placeholders: [string, string][] | ContextPlaceholders,
    ): EmbedBuilder

    Parameters

    • embed: EmbedBuilder
    • placeholders: [string, string][] | ContextPlaceholders

    Returns EmbedBuilder

Staticmatch

  • match(str: string, placeholders: ContextPlaceholders): [string, string][]

    Parameters

    • str: string
    • placeholders: ContextPlaceholders

    Returns [string, string][]

Static Readonlyparse

  • parse<Obj extends object, Prefix extends string = "">(
        obj: Obj,
        placeholderKeys: Exclude<
            ExtractKeys<Obj, "", 3, DefaultIgnoreTypes, "", "">,
            undefined,
        >[],
        prefix?: Prefix,
        depth?: number,
    ): Placeholders<ExtractKeys<Obj, Prefix>, string>

    Type Parameters

    • Obj extends object
    • Prefix extends string = ""

    Parameters

    • obj: Obj
    • placeholderKeys: Exclude<ExtractKeys<Obj, "", 3, DefaultIgnoreTypes, "", "">, undefined>[]
    • Optionalprefix: Prefix
    • depth: number = 3

    Returns Placeholders<ExtractKeys<Obj, Prefix>, string>

StaticparseContext

  • parseContext(
        options: {
            channel: GuildChannel | ThreadChannel<boolean> | "n/a";
            guild: Guild;
            member: GuildMember | PartialGuildMember;
            user: User;
        },
    ): ContextPlaceholders

    Parameters

    • options: {
          channel: GuildChannel | ThreadChannel<boolean> | "n/a";
          guild: Guild;
          member: GuildMember | PartialGuildMember;
          user: User;
      }

    Returns ContextPlaceholders

Settings

Member Visibility

On This Page

Constructors
Properties
Methods