core

package

v1.6.3 Latest Latest Go to latest Published: Apr 20, 2024 License: MIT Imports: 26 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/go-shiori/shiori

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func DownloadBookImage(deps *dependencies.Dependencies, url, dstPath string) error
func DownloadBookmark(url string) (io.ReadCloser, string, error)
func GenerateEbook(deps *dependencies.Dependencies, req ProcessRequest, dstPath string) (book model.BookmarkDTO, err error)
func ProcessBookmark(deps *dependencies.Dependencies, req ProcessRequest) (book model.BookmarkDTO, isFatalErr bool, err error)
func RemoveUTMParams(url string) (string, error)
type ProcessRequest

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrNoSupportedImageType = errors.New("unsupported image type")

Functions ¶

func DownloadBookImage ¶ added in v1.6.0

func DownloadBookImage(deps *dependencies.Dependencies, url, dstPath string) error

func DownloadBookmark ¶

func DownloadBookmark(url string) (io.ReadCloser, string, error)

DownloadBookmark downloads bookmarked page from specified URL. Return response body, make sure to close it later.

func GenerateEbook ¶ added in v1.5.5

func GenerateEbook(deps *dependencies.Dependencies, req ProcessRequest, dstPath string) (book model.BookmarkDTO, err error)

GenerateEbook receives a `ProcessRequest` and generates an ebook file in the destination path specified. The destination path `dstPath` should include file name with ".epub" extension The bookmark model will be used to update the UI based on whether this function is successful or not.

func ProcessBookmark ¶

func ProcessBookmark(deps *dependencies.Dependencies, req ProcessRequest) (book model.BookmarkDTO, isFatalErr bool, err error)

ProcessBookmark process the bookmark and archive it if needed. Return three values, is error fatal, and error value.

func RemoveUTMParams ¶

func RemoveUTMParams(url string) (string, error)

RemoveUTMParams removes the UTM parameters from URL.

Types ¶

type ProcessRequest ¶

type ProcessRequest struct {
	DataDir     string
	Bookmark    model.BookmarkDTO
	Content     io.Reader
	ContentType string
	KeepTitle   bool
	KeepExcerpt bool
	LogArchival bool
}

ProcessRequest is the request for processing bookmark.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL