Module: NBA::CommonPlayoffSeries

Defined in:
lib/nba/common_playoff_series.rb

Overview

Provides methods to retrieve playoff series data

Constant Summary collapse

PLAYOFF_SERIES =

Result set name for playoff series

Returns:

  • (String) —

    the result set name

"PlayoffSeries".freeze

Class Method Summary collapse

Class Method Details

.all(season: Utils.current_season, league: League::NBA, client: CLIENT) ⇒ Collection

Retrieves all playoff series for a season

Examples:

series = NBA::CommonPlayoffSeries.all(season: 2024)
series.each { |s| puts "Game #{s.game_num}: #{s.home_team_id} vs #{s.visitor_team_id}" }

Parameters:

  • season (Integer) (defaults to: Utils.current_season) —

    the season year

  • league (String, League) (defaults to: League::NBA) —

    the league ID or League object (default NBA)

  • client (Client) (defaults to: CLIENT) —

    the API client to use

Returns:



25
26
27
28
29
30
 
# File 'lib/nba/common_playoff_series.rb', line 25

def self.all(season: Utils.current_season, league: League::NBA, client: CLIENT)
  league_id = Utils.extract_league_id(league)
  path = build_path(season, league_id)
  response = client.get(path)
  parse_response(response)
end