Options
All
  • Public
  • Public/Protected
  • All
Menu

reacord

Index

Type aliases

Adapter

Adapter<InteractionInit>: { }

Type parameters

  • InteractionInit

Type declaration

    ButtonClickEvent

    ButtonClickEvent: {}

    Type declaration

      ButtonProps

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

      Type declaration

      • Optional disabled?: boolean
      • Optional emoji?: string
      • Optional label?: string
      • Optional style?: "primary" | "secondary" | "success" | "danger"
      • onClick:function
        • Parameters

          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

      ReacordConfig

      ReacordConfig<InteractionInit>: { adapter: Adapter<InteractionInit>; maxInstances?: number }

      Type parameters

      • InteractionInit

      Type declaration

      • adapter: Adapter<InteractionInit>
      • Optional maxInstances?: number

        The max number of active instances. When this limit is exceeded, the oldest instances will be disabled.

      ReacordInstance

      ReacordInstance: { deactivate: any; render: any }

      Type declaration

      • deactivate:function
        • deactivate(): void
        • Returns void

      • render:function
        • render(content: ReactNode): void
        • Parameters

          • content: ReactNode

          Returns void

      Functions

      Button

      • Parameters

        Returns Element

      Embed

      • Parameters

        Returns Element

      EmbedAuthor

      • Parameters

        Returns Element

      EmbedField

      • Parameters

        Returns Element

      EmbedFooter

      • Parameters

        Returns Element

      EmbedImage

      • Parameters

        Returns Element

      EmbedThumbnail

      • Parameters

        Returns Element

      EmbedTitle

      • Parameters

        Returns Element

      Link

      • Parameters

        Returns Element

      Generated using TypeDoc