github

Documentation

Overview

github package provides an API client for github.com

Copyright (C) 2014 Yohei Sasaki

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

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

Variables

var Gfm = MarkdownMode("gfm")

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