Class Deck

constructor

• new Deck(
      num?: number,
      shouldShuffle?: boolean,
      includeJokers?: boolean,
      ranks?: Rank[],
  ): Deck

  Create a new deck

  Parameters

  • num: number = 0

    the number of decks to include (0 or more)
  • shouldShuffle: boolean = true

    whether the deck should be shuffled automatically
  • includeJokers: boolean = true
  • ranks: Rank[] = Rank.ranks

  Returns Deck

  the new deck

cards

discards

Readonlytype

top

• get top(): null | Card

  Get the top card of the discards, if available

  Returns null | Card

  the top card, or null available

clearTop

• clearTop(): void

  Mark the top card as no longer available

  Returns void

discard

• discard(card: Card): void

  Add a card to the discard pile and mark as available for pickup

  Parameters

  • card: Card

    the card being discarded

  Returns void

draw

• draw(): Card

  Selects a card and removes it

  Returns Card

  the card

flip

• flip(): Card

  Take the first card and flip it over

  Returns Card

  the flipped/top card

  Throws

  an error if there is no card to flip

shuffle

• shuffle(): boolean

  Shuffles the cards of this deck

  Returns boolean

  whether there are still cards in the deck

shuffleDiscard

• shuffleDiscard(): boolean

  Shuffle the discards back into the deck

  Returns boolean

  whether there are still cards in the deck

takeTop

• takeTop(): void

  Pop the top card of the discards and mark as no longer available

  Returns void

toString

• toString(): string

  Convert to basic readable form

  Returns string

  string representation

StaticfromObj

• fromObj(obj: any): Deck

  Parameters

  • obj: any

  Returns Deck