stars

Documentation

Overview

# Github Personal Token: This module requires a github personal token to be able to access the user's profile. See full documentation at: https://gosuki.net/docs/configuration/config-file/#github

Index

• Constants
• Variables
• type StarFetcher
  • func (sf *StarFetcher) Fetch() ([]*gosuki.Bookmark, error)
  • func (sf *StarFetcher) GetStarredRepos(done *sync.WaitGroup)
  • func (sf *StarFetcher) Init(ctx *modules.Context) error
  • func (sf StarFetcher) Interval() time.Duration
  • func (sf StarFetcher) ModInfo() modules.ModInfo
• type StarFetcherConfig
  • func NewStarFetcherConfig() *StarFetcherConfig
• type StarFetcherModel

Constants

const (
	ModID = "github"

	// default sync interval in seconds
	DefaultSyncInterval = 6 * time.Hour
)

Variables

var (
	GHToken string
	Config  *StarFetcherConfig
)

Types

type StarFetcher

type StarFetcher struct{}

This is the module struct. Used to implement module interface

func (*StarFetcher) Fetch

func (sf *StarFetcher) Fetch() ([]*gosuki.Bookmark, error)

func (*StarFetcher) GetStarredRepos

func (sf *StarFetcher) GetStarredRepos(done *sync.WaitGroup)

func (*StarFetcher) Init

func (sf *StarFetcher) Init(ctx *modules.Context) error

NOTE: use Init() to obtain context config params and store them in a model object

func (StarFetcher) Interval

func (sf StarFetcher) Interval() time.Duration

Interval at which the module should be run

func (StarFetcher) ModInfo

func (sf StarFetcher) ModInfo() modules.ModInfo

type StarFetcherConfig

type StarFetcherConfig struct {
	GithubToken  string        `toml:"github-token" mapstructure:"github-token"`
	SyncInterval time.Duration `toml:"sync-interval" mapstructure:"sync-interval"`
}

func NewStarFetcherConfig

func NewStarFetcherConfig() *StarFetcherConfig

type StarFetcherModel

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