From 7fd9c9af125d1964fb910413cd6268848f30c07c Mon Sep 17 00:00:00 2001 From: MapleLeaf <19603573+itsMapleLeaf@users.noreply.github.com> Date: Tue, 28 Dec 2021 13:08:46 -0600 Subject: [PATCH] docs --- docs/classes/Reacord.html | 2 +- docs/classes/ReacordDiscordJs.html | 2 +- docs/classes/ReacordTester.html | 2 +- docs/modules.html | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/classes/Reacord.html b/docs/classes/Reacord.html index daa31e8..f322352 100644 --- a/docs/classes/Reacord.html +++ b/docs/classes/Reacord.html @@ -1 +1 @@ -Reacord | reacord
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Reacord

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

Abstract reply

  • reply(commandInteraction: unknown, initialContent?: ReactNode): ReacordInstance

Abstract send

Generated using TypeDoc

\ No newline at end of file +Reacord | reacord
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Reacord

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

Abstract reply

  • reply(commandInteraction: unknown, initialContent?: ReactNode): ReacordInstance

Abstract send

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/ReacordDiscordJs.html b/docs/classes/ReacordDiscordJs.html index ed5471e..2230ad9 100644 --- a/docs/classes/ReacordDiscordJs.html +++ b/docs/classes/ReacordDiscordJs.html @@ -1 +1 @@ -ReacordDiscordJs | reacord
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReacordDiscordJs

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

reply

  • reply(interaction: CommandInteraction<CacheType>, initialContent?: ReactNode): ReacordInstance

send

Generated using TypeDoc

\ No newline at end of file +ReacordDiscordJs | reacord
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReacordDiscordJs

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

reply

  • reply(interaction: CommandInteraction<CacheType>, initialContent?: ReactNode): ReacordInstance

send

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/ReacordTester.html b/docs/classes/ReacordTester.html index 93d00d8..2da98e1 100644 --- a/docs/classes/ReacordTester.html +++ b/docs/classes/ReacordTester.html @@ -1 +1 @@ -ReacordTester | reacord
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReacordTester

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

messages

  • get messages(): readonly TestMessage[]

Methods

assertMessages

  • assertMessages(expected: { actionRows: (Omit<MessageButtonOptions, "customId" | "onClick" | "onSelect" | "onSelectValue"> | Omit<MessageLinkOptions, "customId" | "onClick" | "onSelect" | "onSelectValue"> | Omit<MessageSelectOptions, "customId" | "onClick" | "onSelect" | "onSelectValue">)[][]; content: string; embeds: { author: undefined | { name: string; url?: string | undefined; icon_url?: string | undefined; }; color: undefined | number; description: undefined | string; fields: undefined | { name: string; value: string; inline?: boolean | undefined; }[]; footer: undefined | { text: string; icon_url?: string | undefined; }; image: undefined | { url: string; }; thumbnail: undefined | { url: string; }; timestamp: undefined | string; title: undefined | string; url: undefined | string; video: undefined | { url: string; } }[] }[]): Promise<void>

  • Parameters

    • expected: { actionRows: (Omit<MessageButtonOptions, "customId" | "onClick" | "onSelect" | "onSelectValue"> | Omit<MessageLinkOptions, "customId" | "onClick" | "onSelect" | "onSelectValue"> | Omit<MessageSelectOptions, "customId" | "onClick" | "onSelect" | "onSelectValue">)[][]; content: string; embeds: { author: undefined | { name: string; url?: string | undefined; icon_url?: string | undefined; }; color: undefined | number; description: undefined | string; fields: undefined | { name: string; value: string; inline?: boolean | undefined; }[]; footer: undefined | { text: string; icon_url?: string | undefined; }; image: undefined | { url: string; }; thumbnail: undefined | { url: string; }; timestamp: undefined | string; title: undefined | string; url: undefined | string; video: undefined | { url: string; } }[] }[]

    Returns Promise<void>

assertRender

  • assertRender(content: ReactNode, expected: { actionRows: (Omit<MessageButtonOptions, "customId" | "onClick" | "onSelect" | "onSelectValue"> | Omit<MessageLinkOptions, "customId" | "onClick" | "onSelect" | "onSelectValue"> | Omit<MessageSelectOptions, "customId" | "onClick" | "onSelect" | "onSelectValue">)[][]; content: string; embeds: { author: undefined | { name: string; url?: string | undefined; icon_url?: string | undefined; }; color: undefined | number; description: undefined | string; fields: undefined | { name: string; value: string; inline?: boolean | undefined; }[]; footer: undefined | { text: string; icon_url?: string | undefined; }; image: undefined | { url: string; }; thumbnail: undefined | { url: string; }; timestamp: undefined | string; title: undefined | string; url: undefined | string; video: undefined | { url: string; } }[] }[]): Promise<void>

  • Parameters

    • content: ReactNode
    • expected: { actionRows: (Omit<MessageButtonOptions, "customId" | "onClick" | "onSelect" | "onSelectValue"> | Omit<MessageLinkOptions, "customId" | "onClick" | "onSelect" | "onSelectValue"> | Omit<MessageSelectOptions, "customId" | "onClick" | "onSelect" | "onSelectValue">)[][]; content: string; embeds: { author: undefined | { name: string; url?: string | undefined; icon_url?: string | undefined; }; color: undefined | number; description: undefined | string; fields: undefined | { name: string; value: string; inline?: boolean | undefined; }[]; footer: undefined | { text: string; icon_url?: string | undefined; }; image: undefined | { url: string; }; thumbnail: undefined | { url: string; }; timestamp: undefined | string; title: undefined | string; url: undefined | string; video: undefined | { url: string; } }[] }[]

    Returns Promise<void>

findButtonByLabel

  • findButtonByLabel(label: string): { click: () => void }

  • Parameters

    • label: string

    Returns { click: () => void }

    • click: () => void
        • (): void

        • Returns void

findSelectByPlaceholder

  • findSelectByPlaceholder(placeholder: string): { select: (...values: string[]) => void }

  • Parameters

    • placeholder: string

    Returns { select: (...values: string[]) => void }

    • select: (...values: string[]) => void
        • (...values: string[]): void

        • Parameters

          • Rest ...values: string[]

          Returns void

logMessages

  • logMessages(): void

reply

sampleMessages

  • sampleMessages(): { actionRows: (Omit<MessageButtonOptions, "customId" | "onClick" | "onSelect" | "onSelectValue"> | Omit<MessageLinkOptions, "customId" | "onClick" | "onSelect" | "onSelectValue"> | Omit<MessageSelectOptions, "customId" | "onClick" | "onSelect" | "onSelectValue">)[][]; content: string; embeds: { author: undefined | { name: string; url?: string | undefined; icon_url?: string | undefined; }; color: undefined | number; description: undefined | string; fields: undefined | { name: string; value: string; inline?: boolean | undefined; }[]; footer: undefined | { text: string; icon_url?: string | undefined; }; image: undefined | { url: string; }; thumbnail: undefined | { url: string; }; timestamp: undefined | string; title: undefined | string; url: undefined | string; video: undefined | { url: string; } }[] }[]

  • Returns { actionRows: (Omit<MessageButtonOptions, "customId" | "onClick" | "onSelect" | "onSelectValue"> | Omit<MessageLinkOptions, "customId" | "onClick" | "onSelect" | "onSelectValue"> | Omit<MessageSelectOptions, "customId" | "onClick" | "onSelect" | "onSelectValue">)[][]; content: string; embeds: { author: undefined | { name: string; url?: string | undefined; icon_url?: string | undefined; }; color: undefined | number; description: undefined | string; fields: undefined | { name: string; value: string; inline?: boolean | undefined; }[]; footer: undefined | { text: string; icon_url?: string | undefined; }; image: undefined | { url: string; }; thumbnail: undefined | { url: string; }; timestamp: undefined | string; title: undefined | string; url: undefined | string; video: undefined | { url: string; } }[] }[]

send

Generated using TypeDoc

\ No newline at end of file +ReacordTester | reacord
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReacordTester

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

messages

  • get messages(): readonly TestMessage[]

Methods

assertMessages

  • assertMessages(expected: { actionRows: (Omit<MessageButtonOptions, "customId" | "onClick" | "onSelect" | "onSelectValue"> | Omit<MessageLinkOptions, "customId" | "onClick" | "onSelect" | "onSelectValue"> | Omit<MessageSelectOptions, "customId" | "onClick" | "onSelect" | "onSelectValue">)[][]; content: string; embeds: { author: undefined | { name: string; url?: string | undefined; icon_url?: string | undefined; }; color: undefined | number; description: undefined | string; fields: undefined | { name: string; value: string; inline?: boolean | undefined; }[]; footer: undefined | { text: string; icon_url?: string | undefined; }; image: undefined | { url: string; }; thumbnail: undefined | { url: string; }; timestamp: undefined | string; title: undefined | string; url: undefined | string; video: undefined | { url: string; } }[] }[]): Promise<void>

  • Parameters

    • expected: { actionRows: (Omit<MessageButtonOptions, "customId" | "onClick" | "onSelect" | "onSelectValue"> | Omit<MessageLinkOptions, "customId" | "onClick" | "onSelect" | "onSelectValue"> | Omit<MessageSelectOptions, "customId" | "onClick" | "onSelect" | "onSelectValue">)[][]; content: string; embeds: { author: undefined | { name: string; url?: string | undefined; icon_url?: string | undefined; }; color: undefined | number; description: undefined | string; fields: undefined | { name: string; value: string; inline?: boolean | undefined; }[]; footer: undefined | { text: string; icon_url?: string | undefined; }; image: undefined | { url: string; }; thumbnail: undefined | { url: string; }; timestamp: undefined | string; title: undefined | string; url: undefined | string; video: undefined | { url: string; } }[] }[]

    Returns Promise<void>

assertRender

  • assertRender(content: ReactNode, expected: { actionRows: (Omit<MessageButtonOptions, "customId" | "onClick" | "onSelect" | "onSelectValue"> | Omit<MessageLinkOptions, "customId" | "onClick" | "onSelect" | "onSelectValue"> | Omit<MessageSelectOptions, "customId" | "onClick" | "onSelect" | "onSelectValue">)[][]; content: string; embeds: { author: undefined | { name: string; url?: string | undefined; icon_url?: string | undefined; }; color: undefined | number; description: undefined | string; fields: undefined | { name: string; value: string; inline?: boolean | undefined; }[]; footer: undefined | { text: string; icon_url?: string | undefined; }; image: undefined | { url: string; }; thumbnail: undefined | { url: string; }; timestamp: undefined | string; title: undefined | string; url: undefined | string; video: undefined | { url: string; } }[] }[]): Promise<void>

  • Parameters

    • content: ReactNode
    • expected: { actionRows: (Omit<MessageButtonOptions, "customId" | "onClick" | "onSelect" | "onSelectValue"> | Omit<MessageLinkOptions, "customId" | "onClick" | "onSelect" | "onSelectValue"> | Omit<MessageSelectOptions, "customId" | "onClick" | "onSelect" | "onSelectValue">)[][]; content: string; embeds: { author: undefined | { name: string; url?: string | undefined; icon_url?: string | undefined; }; color: undefined | number; description: undefined | string; fields: undefined | { name: string; value: string; inline?: boolean | undefined; }[]; footer: undefined | { text: string; icon_url?: string | undefined; }; image: undefined | { url: string; }; thumbnail: undefined | { url: string; }; timestamp: undefined | string; title: undefined | string; url: undefined | string; video: undefined | { url: string; } }[] }[]

    Returns Promise<void>

findButtonByLabel

  • findButtonByLabel(label: string): { click: () => void }

  • Parameters

    • label: string

    Returns { click: () => void }

    • click: () => void
        • (): void

        • Returns void

findSelectByPlaceholder

  • findSelectByPlaceholder(placeholder: string): { select: (...values: string[]) => void }

  • Parameters

    • placeholder: string

    Returns { select: (...values: string[]) => void }

    • select: (...values: string[]) => void
        • (...values: string[]): void

        • Parameters

          • Rest ...values: string[]

          Returns void

logMessages

  • logMessages(): void

reply

sampleMessages

  • sampleMessages(): { actionRows: (Omit<MessageButtonOptions, "customId" | "onClick" | "onSelect" | "onSelectValue"> | Omit<MessageLinkOptions, "customId" | "onClick" | "onSelect" | "onSelectValue"> | Omit<MessageSelectOptions, "customId" | "onClick" | "onSelect" | "onSelectValue">)[][]; content: string; embeds: { author: undefined | { name: string; url?: string | undefined; icon_url?: string | undefined; }; color: undefined | number; description: undefined | string; fields: undefined | { name: string; value: string; inline?: boolean | undefined; }[]; footer: undefined | { text: string; icon_url?: string | undefined; }; image: undefined | { url: string; }; thumbnail: undefined | { url: string; }; timestamp: undefined | string; title: undefined | string; url: undefined | string; video: undefined | { url: string; } }[] }[]

  • Returns { actionRows: (Omit<MessageButtonOptions, "customId" | "onClick" | "onSelect" | "onSelectValue"> | Omit<MessageLinkOptions, "customId" | "onClick" | "onSelect" | "onSelectValue"> | Omit<MessageSelectOptions, "customId" | "onClick" | "onSelect" | "onSelectValue">)[][]; content: string; embeds: { author: undefined | { name: string; url?: string | undefined; icon_url?: string | undefined; }; color: undefined | number; description: undefined | string; fields: undefined | { name: string; value: string; inline?: boolean | undefined; }[]; footer: undefined | { text: string; icon_url?: string | undefined; }; image: undefined | { url: string; }; thumbnail: undefined | { url: string; }; timestamp: undefined | string; title: undefined | string; url: undefined | string; video: undefined | { url: string; } }[] }[]

send

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index b0297d7..0815b28 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,4 +1,4 @@ -reacord
Options
All
  • Public
  • Public/Protected
  • All
Menu

reacord

Index

Classes

Type aliases

Functions

Type aliases

ActionRowProps

ActionRowProps: { children?: ReactNode }

Type declaration

  • Optional children?: ReactNode

ButtonClickEvent

ButtonClickEvent: {}

Type declaration

    ButtonProps

    ButtonProps: { disabled?: boolean; emoji?: string; label?: string; style?: "primary" | "secondary" | "success" | "danger"; onClick: any }

    Type declaration

    ComponentInteractionListener

    ComponentInteractionListener: (interaction: ComponentInteraction) => void

    Type declaration

      • (interaction: ComponentInteraction): void

      • Parameters

        • interaction: ComponentInteraction

        Returns void

    EmbedAuthorProps

    EmbedAuthorProps: { children?: string; iconUrl?: string; name?: string; url?: string }

    Type declaration

    • Optional children?: string
    • Optional iconUrl?: string
    • Optional name?: string
    • Optional url?: string

    EmbedFieldProps

    EmbedFieldProps: { children?: string; inline?: boolean; name: string; value?: string }

    Type declaration

    • Optional children?: string
    • Optional inline?: boolean
    • name: string
    • Optional value?: string

    EmbedFooterProps

    EmbedFooterProps: { children?: string; iconUrl?: string; text?: string; timestamp?: string | number | Date }

    Type declaration

    • Optional children?: string
    • Optional iconUrl?: string
    • Optional text?: string
    • Optional timestamp?: string | number | Date

    EmbedImageProps

    EmbedImageProps: { url: string }

    Type declaration

    • url: string

    EmbedProps

    EmbedProps: { author?: { iconUrl?: string; name: string; url?: string }; children?: React.ReactNode; color?: number; description?: string; fields?: { inline?: boolean; name: string; value: string }[]; footer?: { iconUrl?: string; text: string }; image?: { url: string }; thumbnail?: { url: string }; timestamp?: string | number | Date; title?: string; url?: string; video?: { url: string } }

    Type declaration

    • Optional author?: { iconUrl?: string; name: string; url?: string }
      • Optional iconUrl?: string
      • name: string
      • Optional url?: string
    • Optional children?: React.ReactNode
    • Optional color?: number
    • Optional description?: string
    • Optional fields?: { inline?: boolean; name: string; value: string }[]
    • Optional footer?: { iconUrl?: string; text: string }
      • Optional iconUrl?: string
      • text: string
    • Optional image?: { url: string }
      • url: string
    • Optional thumbnail?: { url: string }
      • url: string
    • Optional timestamp?: string | number | Date
    • Optional title?: string
    • Optional url?: string
    • Optional video?: { url: string }
      • url: string

    EmbedThumbnailProps

    EmbedThumbnailProps: { url: string }

    Type declaration

    • url: string

    EmbedTitleProps

    EmbedTitleProps: { children: string; url?: string }

    Type declaration

    • children: string
    • Optional url?: string

    LinkProps

    LinkProps: { children?: string; disabled?: boolean; emoji?: string; label?: string; url: string }

    Type declaration

    • Optional children?: string
    • Optional disabled?: boolean
    • Optional emoji?: string
    • Optional label?: string
    • url: string

    OptionProps

    OptionProps: { children?: string; description?: string; emoji?: string; label?: string; value: string }

    Type declaration

    • Optional children?: string
    • Optional description?: string
    • Optional emoji?: string
    • Optional label?: string
    • value: string

    ReacordConfig

    ReacordConfig: { maxInstances?: number }

    Type declaration

    ReacordInstance

    ReacordInstance: { deactivate: any; destroy: any; render: any }

    Type declaration

    SelectEvent

    SelectEvent: { values: string[] }

    Type declaration

    • values: string[]

    SelectProps

    SelectProps: { children?: ReactNode; disabled?: boolean; maxValues?: number; minValues?: number; multiple?: boolean; placeholder?: string; value?: string; values?: string[]; onSelect?: any; onSelectMultiple?: any; onSelectValue?: any }

    Type declaration

    • Optional children?: ReactNode
    • Optional disabled?: boolean
    • Optional maxValues?: number
    • Optional minValues?: number
    • Optional multiple?: boolean
    • Optional placeholder?: string
    • Optional value?: string
    • Optional values?: string[]
    • onSelect?:function
    • onSelectMultiple?:function
      • onSelectMultiple(values: string[]): void
    • onSelectValue?:function
      • onSelectValue(value: string): void

    Functions

    ActionRow

    Button

    Embed

    EmbedAuthor

    EmbedField

    EmbedFooter

    EmbedImage

    EmbedThumbnail

    EmbedTitle

    Link

    Option

    Select

    Generated using TypeDoc

    \ No newline at end of file