novel

Documentation

Index

• func HTMLContent(ctx context.Context, renderer ContentRenderer, content string) (ret string, err error)
• type ContentRenderer
• type Novel
  • func (i *Novel) Fetch(ctx context.Context) (err error)
  • func (i Novel) HTMLContent(ctx context.Context, renderer ContentRenderer) (string, error)
  • func (i Novel) URL(ctx context.Context) *url.URL
• type SearchOption
  • func SearchOptionPage(page int) SearchOption
• type SearchOptions
• type SearchResult
  • func Search(ctx context.Context, query string, opts ...SearchOption) (result SearchResult, err error)
  • func (r SearchResult) ForEach(iterator func(key, value gjson.Result) bool)
  • func (r SearchResult) Novels() []Novel
• type Series
  • func (i Series) URL() *url.URL
  • func (i Series) URLWithClient(c client.Client) *url.URL
• type SimpleContentRenderer
  • func (r SimpleContentRenderer) Chapter(ctx context.Context, name string) (ret string, err error)
  • func (r SimpleContentRenderer) Image(ctx context.Context, id string, index int) (ret string, err error)
  • func (r SimpleContentRenderer) JumpPage(ctx context.Context, index int) (ret string, err error)
  • func (r SimpleContentRenderer) JumpURI(ctx context.Context, title, uri string) (ret string, err error)
  • func (r SimpleContentRenderer) NewPage(ctx context.Context, index int) (ret string, err error)
  • func (r SimpleContentRenderer) Paragraph(ctx context.Context, text string) (ret string, err error)
  • func (r SimpleContentRenderer) Ruby(ctx context.Context, ruby, rt string) (string, error)

Functions

func HTMLContent

func HTMLContent(ctx context.Context, renderer ContentRenderer, content string) (ret string, err error)

HTMLContent render novel content to html. format from https://www.pixiv.net/novel/upload.php

Types

type ContentRenderer

type ContentRenderer interface {
	Image(ctx context.Context, id string, index int) (string, error)
	Paragraph(ctx context.Context, text string) (string, error)
	NewPage(ctx context.Context, index int) (string, error)
	Ruby(ctx context.Context, ruby, rt string) (string, error)
	Chapter(ctx context.Context, name string) (string, error)
	JumpURI(ctx context.Context, title, uri string) (string, error)
	JumpPage(ctx context.Context, page int) (string, error)
}

ContentRenderer can render novel content

type Novel

type Novel struct {
	ID          string
	Title       string
	Description string
	CoverURL    string
	Content     string
	Created     time.Time
	Uploaded    time.Time
	Author      user.User
	Series      Series
	Tags        []string

	TextCount     int64
	PageCount     int64
	CommentCount  int64
	LikeCount     int64
	ViewCount     int64
	BookmarkCount int64
}

Novel data

func (*Novel) Fetch

func (i *Novel) Fetch(ctx context.Context) (err error)

Fetch additional data from pixiv single novel api (require login),

func (Novel) HTMLContent

func (i Novel) HTMLContent(ctx context.Context, renderer ContentRenderer) (string, error)

HTMLContent from content

func (Novel) URL

func (i Novel) URL(ctx context.Context) *url.URL

URL to view web page.

type SearchOption

type SearchOption func(*SearchOptions)

SearchOption mutate SearchOptions

func SearchOptionPage

func SearchOptionPage(page int) SearchOption

SearchOptionPage change page to retrive

type SearchOptions

type SearchOptions struct {
	Page int
}

SearchOptions for Search

type SearchResult

type SearchResult struct {
	JSON gjson.Result
}

SearchResult holds search data and provide useful methods.

func Search

func Search(ctx context.Context, query string, opts ...SearchOption) (result SearchResult, err error)

Search calls pixiv novel search api.

func (SearchResult) ForEach

func (r SearchResult) ForEach(iterator func(key, value gjson.Result) bool)

ForEach iterates through novel data items.

func (SearchResult) Novels

func (r SearchResult) Novels() []Novel

Novels appeared in the search result.

type Series

type Series struct {
	ID    string
	Title string
}

Series data

func (Series) URL

func (i Series) URL() *url.URL

URL to view web page.

func (Series) URLWithClient

func (i Series) URLWithClient(c client.Client) *url.URL

URLWithClient to view web page.

type SimpleContentRenderer

type SimpleContentRenderer struct{}

SimpleContentRenderer is a simple implementation of ContentRenderer

func (SimpleContentRenderer) Chapter

func (r SimpleContentRenderer) Chapter(ctx context.Context, name string) (ret string, err error)

Chapter implements ContentRenderer

func (SimpleContentRenderer) Image

func (r SimpleContentRenderer) Image(ctx context.Context, id string, index int) (ret string, err error)

Image implements ContentRenderer

func (SimpleContentRenderer) JumpPage

func (r SimpleContentRenderer) JumpPage(ctx context.Context, index int) (ret string, err error)

JumpPage implements ContentRenderer

func (SimpleContentRenderer) JumpURI

func (r SimpleContentRenderer) JumpURI(ctx context.Context, title, uri string) (ret string, err error)

JumpURI implements ContentRenderer

func (SimpleContentRenderer) NewPage

func (r SimpleContentRenderer) NewPage(ctx context.Context, index int) (ret string, err error)

NewPage implements ContentRenderer

func (SimpleContentRenderer) Paragraph

func (r SimpleContentRenderer) Paragraph(ctx context.Context, text string) (ret string, err error)

Paragraph implements ContentRenderer

func (SimpleContentRenderer) Ruby

func (r SimpleContentRenderer) Ruby(ctx context.Context, ruby, rt string) (string, error)

Ruby implements ContentRenderer