Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Card

Hierarchy

  • Card

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional color

color: string

modules

modules: ModuleObject[] = []

size

size: "lg" | "sm" = 'lg'

Optional theme

theme: Theme

type

type: "card" = 'card'

Methods

addCountdown

  • addCountdown(mode: "second" | "hour" | "day", endTime: number | Date, startTime?: number | Date): Card

  • Parameters

    • mode: "second" | "hour" | "day"
    • endTime: number | Date
    • Optional startTime: number | Date

    Returns Card

addDivider

  • addDivider(): Card

addImage

  • addImage(source: string, options?: { alt?: string; circle?: boolean; size?: "lg" | "sm" }): Card

  • Parameters

    • source: string
    • Optional options: { alt?: string; circle?: boolean; size?: "lg" | "sm" }
      • Optional alt?: string
      • Optional circle?: boolean
      • Optional size?: "lg" | "sm"

    Returns Card

addModule

addText

  • addText(content: string, emoji?: boolean, accessoryMode?: "right" | "left", accessory?: any): Card

  • Parameters

    • content: string
    • emoji: boolean = true
    • accessoryMode: "right" | "left" = 'right'
    • accessory: any = {}

    Returns Card

addTitle

  • addTitle(title: string, emoji?: boolean): Card

setColor

  • setColor(color: string): Card

setSize

  • setSize(size: "lg" | "sm"): Card

setTheme

stringify

  • stringify(): string

toString

  • toString(arrayBracket?: boolean): string

  • Export card object to string. You can use this if you need stringified card with array bracket(usually used when sending single card).

    memberof

    Card

    Parameters

    • arrayBracket: boolean = true

    Returns string

    {string}

Static validate

Generated using TypeDoc