github

package

v0.0.0-...-f26991d Latest Latest Go to latest Published: Oct 25, 2015 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/speedland/wcg

Documentation ¶

Overview ¶

github package provides an API client for github.com

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Index ¶

Constants
Variables
func IsApiError(err error) bool
type ApiError
- func NewApiError(status int, body string, c *Client) *ApiError
- func (e *ApiError) Error() string
type Client
- func NewClient(c *http.Client) *Client
- func (g *Client) LimitExceeded() bool
- func (g *Client) Markdown(text string, mode MarkdownMode, context string) (string, error)
type MarkdownMode

Constants ¶

View Source

const BaseUrl = "https://api.github.com"

Variables ¶

View Source

var Gfm = MarkdownMode("gfm")

View Source

var Markdown = MarkdownMode("markdown")

Functions ¶

func IsApiError ¶

func IsApiError(err error) bool

Types ¶

type ApiError ¶

type ApiError struct {
	Status int
	Body   string
	*Client
}

func NewApiError ¶

func NewApiError(status int, body string, c *Client) *ApiError

func (*ApiError) Error ¶

func (e *ApiError) Error() string

type Client ¶

type Client struct {
	RateLimit          int
	RateLimitRemaining int
	RateLimitReset     time.Time
	// contains filtered or unexported fields
}

func NewClient ¶

func NewClient(c *http.Client) *Client

func (*Client) LimitExceeded ¶

func (g *Client) LimitExceeded() bool

Returns if the client exceeds the limit or not.

func (*Client) Markdown ¶

func (g *Client) Markdown(text string, mode MarkdownMode, context string) (string, error)

Call /markdown API See: https://developer.github.com/v3/markdown/

type MarkdownMode ¶

type MarkdownMode string

Source Files ¶

View all Source files

api.go

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