fastgogi

README

fastgogi

A Golang gitignore.io fetching library using fasthttp 🏃

Example

package main

import "github.com/gofunky/fastgogi"
import "fmt"

func main() {
	myGogi := fastgogi.NewClient()
	
	// Get the list of available types.
	availableTypes, err := myGogi.List()
	if err != nil {
		panic(err)
	}
	fmt.Printf("Available Types:\n%s", availableTypes)
	
	// Get the gitignore template for Go and IntelliJ.
	gitignoreContent, err := myGogi.Get("go", "IntelliJ")
	if err != nil {
		panic(err)
	}
	fmt.Printf("Available Types:\n%s", gitignoreContent)
}

Why is there no cmd version?

Check out this generator: gogigen

Documentation

Index

• Constants
• func NewClient() (client *fastGogiClient)
• func NewClientWithOptions(options FastGogiOptions) (client *fastGogiClient)
• func UseLogger(logger *onelog.Logger)
• type FastGogiOptions

Constants

const (
	// Version of FastGogi
	Version = "1.0.0"
	// StartComment indicates the beginning of the gitignore template
	StartComment = "# Created by "
	// EndComment indicates the end of the gitignore template
	EndComment = "# End of "
)

Functions

func NewClient

func NewClient() (client *fastGogiClient)

NewClient returns a default fastGogiClient.

func NewClientWithOptions

func NewClientWithOptions(options FastGogiOptions) (client *fastGogiClient)

NewClientWithOptions is the factory for a new fastGogiClient.

func UseLogger

func UseLogger(logger *onelog.Logger)

UseLogger sets a custom Logger for the package.

Types

type FastGogiOptions

type FastGogiOptions struct {
	UserAgent string
	Host      string
}

FastGogiOptions contain the http client parameters.