srcom_api

package

v0.0.0-...-3714c51 Latest Latest Go to latest Published: Jan 25, 2025 License: GPL-3.0 Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/alexmerren/speedruncom-scraper

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
type HttpClient
type SrcomV1Client
- func NewSrcomV1Client(client HttpClient) *SrcomV1Client
type SrcomV2Client
- func NewSrcomV2Client(client HttpClient) *SrcomV2Client
- func (c *SrcomV2Client) GetGameList(pageNumber int) ([]byte, error)
- func (c *SrcomV2Client) GetGameRecordHistory(gameId, categoryId string, levelId *string, variables, values []string) ([]byte, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var DefaultV1Client = NewSrcomV1Client(
	http_client.NewHttpClient(
		http_client.WithLogging(),
		http_client.WithRetry(100, 5),
		http_client.WithCache(newCache()),
	),
)

View Source

var DefaultV2Client = NewSrcomV2Client(
	http_client.NewHttpClient(
		http_client.WithLogging(),
		http_client.WithRetry(1_000, 3),
		http_client.WithCache(newCache()),
	),
)

Functions ¶

This section is empty.

Types ¶

type HttpClient ¶

type HttpClient interface {
	Get(url string) ([]byte, error)
}

type SrcomV1Client ¶

type SrcomV1Client struct {
	// contains filtered or unexported fields
}

func NewSrcomV1Client ¶

func NewSrcomV1Client(client HttpClient) *SrcomV1Client

func (*SrcomV1Client) GetCategory ¶

func (c *SrcomV1Client) GetCategory(categoryId string) ([]byte, error)

func (*SrcomV1Client) GetDeveloperList ¶

func (c *SrcomV1Client) GetDeveloperList(pageNumber int) ([]byte, error)

func (*SrcomV1Client) GetEngineList ¶

func (c *SrcomV1Client) GetEngineList(pageNumber int) ([]byte, error)

func (*SrcomV1Client) GetGame ¶

func (c *SrcomV1Client) GetGame(gameId string) ([]byte, error)

func (*SrcomV1Client) GetGameList ¶

func (c *SrcomV1Client) GetGameList(pageNumber int) ([]byte, error)

func (*SrcomV1Client) GetGenreList ¶

func (c *SrcomV1Client) GetGenreList(pageNumber int) ([]byte, error)

func (*SrcomV1Client) GetLeaderboardByGameCategory ¶

func (c *SrcomV1Client) GetLeaderboardByGameCategory(gameId, categoryId string) ([]byte, error)

func (*SrcomV1Client) GetLeaderboardByGameLevelCategory ¶

func (c *SrcomV1Client) GetLeaderboardByGameLevelCategory(gameId, levelId, categoryId string) ([]byte, error)

func (*SrcomV1Client) GetLeaderboardByVariables ¶

func (c *SrcomV1Client) GetLeaderboardByVariables(gameId, categoryId string, levelId *string, variables, values []string) ([]byte, error)

func (*SrcomV1Client) GetLevel ¶

func (c *SrcomV1Client) GetLevel(levelId string) ([]byte, error)

func (*SrcomV1Client) GetPlatformList ¶

func (c *SrcomV1Client) GetPlatformList(pageNumber int) ([]byte, error)

func (*SrcomV1Client) GetPublisherList ¶

func (c *SrcomV1Client) GetPublisherList(pageNumber int) ([]byte, error)

func (*SrcomV1Client) GetRunsByUser ¶

func (c *SrcomV1Client) GetRunsByUser(userId string, pageNumber int) ([]byte, error)

func (*SrcomV1Client) GetUser ¶

func (c *SrcomV1Client) GetUser(userId string) ([]byte, error)

type SrcomV2Client ¶

type SrcomV2Client struct {
	// contains filtered or unexported fields
}

func NewSrcomV2Client ¶

func NewSrcomV2Client(client HttpClient) *SrcomV2Client

func (*SrcomV2Client) GetGameList ¶

func (c *SrcomV2Client) GetGameList(pageNumber int) ([]byte, error)

func (*SrcomV2Client) GetGameRecordHistory ¶

func (c *SrcomV2Client) GetGameRecordHistory(gameId, categoryId string, levelId *string, variables, values []string) ([]byte, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL