Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "search"

Index

Functions

Functions

getMatchingFrames

  • getMatchingFrames(frames: FrameEntryType[], criteria: FrameCriteriaType): FrameEntryType[]

getMatchingGames

  • getMatchingGames(games: Iterable<SlippiGame>, criteria: GameCriteriaType): SlippiGame[]

  • Filter for all the matching games from a SlippiGame iterable

    Parameters

    Returns SlippiGame[]

isValidFrame

isValidGame

isValidPlayer

  • Find out if player matches the given criteria

    Parameters

    Returns boolean

isValidPlayerFrame

  • isValidPlayerFrame(playerFrame: { post: PostFrameUpdateType; pre: PreFrameUpdateType }, criteria: PlayerFrameCriteriaType): boolean

  • Find out if player frame matches the given criteria

    Parameters

    • playerFrame: { post: PostFrameUpdateType; pre: PreFrameUpdateType }

      Player frame object that will be checked

      • post: PostFrameUpdateType
      • pre: PreFrameUpdateType
    • criteria: PlayerFrameCriteriaType

      Criteria with required player frame attributes

    Returns boolean

isValidPostFrameUpdate

  • Find out if postframe update matches the given criteria

    Parameters

    • post: PostFrameUpdateType

      [[PostFrameUpdateType]] object that will be checked

    • criteria: PostFrameUpdateCriteriaType

      Criteria with required postframe attributes

    Returns boolean

isValidPreFrameUpdate

  • Find out if preframe update matches the given criteria

    Parameters

    • pre: PreFrameUpdateType

      [[PreFrameUpdateType]] object that will be checked

    • criteria: PreFrameUpdateCriteriaType

      Criteria with required preframe attributes

    Returns boolean

withMatchingFrames

  • withMatchingFrames(frames: Iterable<FrameEntryType>, criteria: FrameCriteriaType, callback: (frame: FrameEntryType) => void): void

  • Perform some function with an iterable of FrameEntryType frames that fit some given criteria

    Parameters

    • frames: Iterable<FrameEntryType>

      An iterable of FrameEntryType frames

    • criteria: FrameCriteriaType

      Criteria with required frame attributes

    • callback: (frame: FrameEntryType) => void

      Callback function to be called with each matching frame

        • (frame: FrameEntryType): void

        • Parameters

          • frame: FrameEntryType

          Returns void

    Returns void

withMatchingGames

  • withMatchingGames(games: Iterable<SlippiGame>, criteria: GameCriteriaType, callback: (game: SlippiGame) => void): void

  • Perform some function with an iterable of SlippiGame games that fit some given criteria

    Parameters

    • games: Iterable<SlippiGame>

      An iterable of SlippiGame games

    • criteria: GameCriteriaType

      Criteria with required game attributes

    • callback: (game: SlippiGame) => void

      Callback function to be called with each matching game

        • (game: SlippiGame): void

        • Parameters

          • game: SlippiGame

          Returns void

    Returns void

Generated using TypeDoc