cachedPageDownloader

README

golang-cachedPageDownloader

This package makes it easy to download — or access previously cached versions of — webpages.

Example

package main

import (
	"fmt"
	"time"

	cachedPageDownloader "github.com/theTardigrade/golang-cachedPageDownloader"
)

const (
	exampleURL = "https://google.com/"
)

func main() {
	downloader, err := cachedPageDownloader.NewDownloader(&cachedPageDownloader.Options{
		CacheDir:               "./cache",
		MaxCacheDuration:       time.Minute * 5,
		ShouldKeepCacheOnClose: false,
	})
	if err != nil {
		panic(err)
	}
	defer downloader.Close()

	// calling the function below will retrieve the content of the webpage from the internet
	content, isFromCache, err := downloader.Download(exampleURL)
	if err != nil {
		panic(err)
	}

	fmt.Println(len(content))
	fmt.Println(isFromCache) // false

	fmt.Println("*****")

	// calling the function again will retrieve the content of the webpage from our cache
	content, isFromCache, err = downloader.Download(exampleURL)
	if err != nil {
		panic(err)
	}

	fmt.Println(len(content))
	fmt.Println(isFromCache) // true
}

Support

If you use this package, or find any value in it, please consider donating:

Documentation

Index

• Variables
• type Downloader
  • func NewDownloader(options *Options) (downloader *Downloader, err error)
  • func (downloader *Downloader) CacheDir() string
  • func (downloader *Downloader) Clean() (err error)
  • func (downloader *Downloader) Clear() (err error)
  • func (downloader *Downloader) Close() (err error)
  • func (downloader *Downloader) Download(rawURL string) (content []byte, isFromCache bool, err error)
  • func (downloader *Downloader) MaxCacheDuration() time.Duration
  • func (downloader *Downloader) ShouldKeepCacheOnClose() bool
• type Options

Variables

var (
	ErrStatusCodeNotOK = errors.New("status code not ok")
)

Types

type Downloader

type Downloader struct {
	// contains filtered or unexported fields
}

func NewDownloader

func NewDownloader(options *Options) (downloader *Downloader, err error)

func (*Downloader) CacheDir

func (downloader *Downloader) CacheDir() string

func (*Downloader) Clean

func (downloader *Downloader) Clean() (err error)

func (*Downloader) Clear

func (downloader *Downloader) Clear() (err error)

func (*Downloader) Close

func (downloader *Downloader) Close() (err error)

func (*Downloader) Download

func (downloader *Downloader) Download(rawURL string) (content []byte, isFromCache bool, err error)

func (*Downloader) MaxCacheDuration

func (downloader *Downloader) MaxCacheDuration() time.Duration

func (*Downloader) ShouldKeepCacheOnClose

func (downloader *Downloader) ShouldKeepCacheOnClose() bool

type Options

type Options struct {
	CacheDir               string
	MaxCacheDuration       time.Duration
	ShouldKeepCacheOnClose bool
}