api

Documentation

Overview

Package api provides a general API result.

Index

• Constants
• Variables
• func Client() *http.Client
• type Result
  • func (res *Result) ToJSON() string
  • func (res *Result) ToJSONL() string

Constants

const (
	Clean      = "clean"
	Unknown    = "unknown"
	Unrated    = "unrated"
	Breached   = "breached"
	Suspicious = "suspicious"
)

Variables

var Timeout = time.Second * 30

Timeout to use (general)

var UserAgent = "check"

UserAgent to use (general)

Functions

func Client

func Client() *http.Client

Client returns the default HTTP client.

Types

type Result

type Result struct {
	Verdict string            `json:"verdict,omitempty"`
	Details map[string]string `json:"details,omitempty"`
	Stats   struct {
		All int `json:"all,omitempty"`
		Bad int `json:"bad,omitempty"`
	} `json:"stats,omitempty"`
}

Result of API call.

func (*Result) ToJSON

func (res *Result) ToJSON() string

ToJSON returns the result as JSON object.

func (*Result) ToJSONL

func (res *Result) ToJSONL() string

ToJSONL returns the result as JSON lines.