github_ratelimit

Jan 13, 2024

Changes in this version

+ func WithOverrideConfig(ctx context.Context, opts ...Option) context.Context

type Option

+ func GetConfigOverrides(ctx context.Context) []Option

+ type SecondaryRateLimitConfig struct

+ func (c *SecondaryRateLimitConfig) ApplyOptions(opts ...Option)

+ func (c *SecondaryRateLimitConfig) IsAboveSingleSleepLimit(sleepTime time.Duration) bool

+ func (c *SecondaryRateLimitConfig) IsAboveTotalSleepLimit(sleepTime time.Duration, totalSleepTime time.Duration) bool

Dec 11, 2023

Changes in this version

+ const SecondaryRateLimitDocumentationPathSuffix

Oct 25, 2023

Changes in this version

+ const SecondaryRateLimitDocumentationPath

Jul 26, 2023

Changes in this version

+ const SecondaryRateLimitDocumentationURL

+ const SecondaryRateLimitMessage

+ type SecondaryRateLimitBody struct

+ DocumentURL string

+ Message string

+ func (s SecondaryRateLimitBody) IsSecondaryRateLimit() bool

Apr 29, 2023

Changes in this version

+ const HeaderRetryAfter

+ const HeaderXRateLimitRemaining

+ const HeaderXRateLimitReset

type SecondaryRateLimitWaiter

+ Base http.RoundTripper

Jan 27, 2023

Changes in this version

+ func NewRateLimitWaiterClient(base http.RoundTripper, opts ...Option) (*http.Client, error)

+ type CallbackContext struct

+ Request *http.Request

+ Response *http.Response

+ RoundTripper *SecondaryRateLimitWaiter

+ SleepUntil *time.Time

+ TotalSleepTime *time.Duration

+ UserContext *context.Context

+ type OnLimitDetected func(*CallbackContext)

+ type OnSingleLimitExceeded func(*CallbackContext)

+ type OnTotalLimitExceeded func(*CallbackContext)

+ type Option func(*SecondaryRateLimitWaiter)

+ func WithLimitDetectedCallback(callback OnLimitDetected) Option

+ func WithSingleSleepLimit(limit time.Duration, callback OnSingleLimitExceeded) Option

+ func WithTotalSleepLimit(limit time.Duration, callback OnTotalLimitExceeded) Option

+ func WithUserContext(ctx context.Context) Option

+ type SecondaryRateLimitWaiter struct

+ func NewRateLimitWaiter(base http.RoundTripper, opts ...Option) (*SecondaryRateLimitWaiter, error)

+ func (t *SecondaryRateLimitWaiter) RoundTrip(request *http.Request) (*http.Response, error)