makelink

Documentation

Index

• func StyleList() string
• type Link
  • func New(ctx context.Context, urlStr, userAgent string) (*Link, error)
  • func (lnk *Link) CanonicalURL() string
  • func (lnk *Link) Encode(t Style) io.Reader
  • func (lnk *Link) String() string
  • func (lnk *Link) TitleName() string
• type Style
  • func GetStyle(s string) (Style, error)
  • func (t Style) String() string

Examples

• New

Functions

func StyleList

func StyleList() string

StyleList returns string Style list

Types

type Link

type Link struct {
	URL         string `json:"url,omitempty"`
	Location    string `json:"location,omitempty"`
	Canonical   string `json:"canonical,omitempty"`
	Title       string `json:"title,omitempty"`
	Description string `json:"description,omitempty"`
}

Link class is information of URL

func New

func New(ctx context.Context, urlStr, userAgent string) (*Link, error)

New returns new Link instance

Example

link, err := New(context.Background(), "https://git.io/vFR5M", "")
if err != nil {
	fmt.Println(err)
	return
}
fmt.Println(link.Encode(StyleMarkdown))

Output:

[GitHub - goark/ml: Make Link with Markdown Format](https://github.com/goark/ml)

func (*Link) CanonicalURL

func (lnk *Link) CanonicalURL() string

CanonicalURL returns the canonical URL.

func (*Link) Encode

func (lnk *Link) Encode(t Style) io.Reader

Encode returns string (io.Reader) with other style

func (*Link) String

func (lnk *Link) String() string

func (*Link) TitleName

func (lnk *Link) TitleName() string

TitleName returns string of title name

type Style

type Style int

Style as link style

const (
	//StyleUnknown is unknown link style
	StyleUnknown Style = iota
	//StyleMarkdown is unknown markdown style
	StyleMarkdown
	//StyleWiki is unknown wiki style
	StyleWiki
	//StyleHTML is unknown HTML anchor style
	StyleHTML
	//StyleCSV is CSV data format
	StyleCSV
	//StyleJSON is JSON format
	StyleJSON
)

func GetStyle

func GetStyle(s string) (Style, error)

GetStyle returns Style from string

func (Style) String

func (t Style) String() string