Function WithTimeout

github/github.go:397–406

WithTimeout returns a ClientOptionsFunc that sets the timeout for a Client. This overrides the timeout set by [WithHTTPClient]. If not set and no HTTP client is provided, the default http.Client with no timeout will be used. It is recommended to provide a timeout for production environments.

(timeout time.Duration)

// client is provided, the default http.Client with no timeout will be used.
// It is recommended to provide a timeout for production environments.
func WithTimeout(timeout time.Duration) ClientOptionsFunc {
	return func(o *clientOptions) error {
		if timeout < 0 {
			return errors.New("timeout must not be negative")
		}

		o.timeout = &timeout
		return nil
	}
}

// WithUserAgent returns a ClientOptionsFunc that sets the User-Agent header
// for a Client. If not set, a default User-Agent will be used.