firehose

package module

Go to main page

Versions in this module

v0

v0.2.4

Jul 16, 2026

Changes in this version

type Feed

+ Timezone string

type FeedConf

+ Timezone string

v0.2.3

Jul 16, 2026

Changes in this version

type Feed

+ ExcludeURL []string

+ IncludeURL []string

type FeedConf

+ ExcludeURL []string

+ IncludeURL []string

type Settings

+ LinksNewTab bool

v0.2.2

Jul 15, 2026

Changes in this version

+ func IsLocalFeed(url string) bool

+ func LocalFeedPath(url string) string

+ func RewriteHost(raw string, rules map[string]string) string

type Feed

+ RewriteHost map[string]string

type FeedConf

+ RewriteHost map[string]string

v0.2.1

Jul 14, 2026

Changes in this version

+ func CategoriesIntersect(cats, want []string) bool

+ func ContainsCategory(cats []string, want string) bool

v0.2.0

Jul 13, 2026

Changes in this version

type Config

+ func (c *Config) MaxDisplayWindow() time.Duration

+ func (c *Config) WindowFor(fc FeedConf) time.Duration

type FeedConf

+ DisplayWindow Duration

type ItemService

+ ItemStats func(ctx context.Context) ([]ItemStat, error)

+ type ItemStat struct

+ FeedID int64

+ Published time.Time

type Settings

+ Dedupe bool

v0.1.0

Jul 13, 2026

Changes in this version

+ const ECONFLICT

+ const EINTERNAL

+ const EINVALID

+ const ENOTFOUND

+ const EPANIC

+ const EPARSE

+ const ETIMEOUT

+ var Version = "dev"

+ func DefaultConfigTOML() string

+ func ErrorCode(err error) string

+ type BodyScope string

+ const BodyExcerpt

+ const BodyExcerptExpand

+ const BodyFull

+ const BodyTitle

+ func ResolveBody(settings, output, feed BodyScope) BodyScope

+ type Config struct

+ Feeds []FeedConf

+ Fetch FetchConfig

+ Fonts FontConfig

+ Location *time.Location

+ Outputs []OutputConf

+ Settings Settings

+ Warnings []string

+ func DefaultConfig() *Config

+ func LoadConfig(path string) (*Config, error)

+ func (c *Config) FeedConfByURL() map[string]FeedConf

+ func (c *Config) FontsCSSURL() string

+ func (c *Config) ToFeeds() []*Feed

+ func (c *Config) ToOutputs() []*Output

+ func (c *Config) Validate() error

+ type Duration time.Duration

+ func (d *Duration) UnmarshalText(text []byte) error

+ func (d Duration) D() time.Duration

+ type Error struct

+ Code string

+ Message string

+ func Errorf(code, format string, args ...any) *Error

+ func (e *Error) Error() string

+ type ExcerptImage string

+ const ExcerptImageLead

+ const ExcerptImageNone

+ func ResolveExcerptImage(settings, output, feed ExcerptImage) ExcerptImage

+ type Feed struct

+ Body string

+ Categories []string

+ ETag string

+ ExcerptImage string

+ Exclude []string

+ FailCount int

+ Headers map[string]string

+ ID int64

+ Include []string

+ LastFetched time.Time

+ LastModified string

+ LastStatus string

+ LastSuccess time.Time

+ NextEarliest time.Time

+ StripSelectors []string

+ Title string

+ URL string

+ UserAgent string

+ type FeedConf struct

+ Body BodyScope

+ Categories []string

+ ExcerptImage ExcerptImage

+ Exclude []string

+ Headers map[string]string

+ Include []string

+ StripSelectors []string

+ Title string

+ URL string

+ UserAgent string

+ type FeedFilter struct

+ Category *string

+ DueOnly bool

+ ID *int64

+ Limit int

+ Offset int

+ URL *string

+ type FeedService interface

+ FindFeedByURL func(ctx context.Context, url string) (*Feed, error)

+ FindFeeds func(ctx context.Context, filter FeedFilter) ([]*Feed, int, error)

+ SyncFeeds func(ctx context.Context, feeds []*Feed) error

+ UpdateFeed func(ctx context.Context, id int64, upd FeedUpdate) (*Feed, error)

+ type FeedUpdate struct

+ ETag *string

+ FailCount *int

+ LastFetched *time.Time

+ LastModified *string

+ LastStatus *string

+ LastSuccess *time.Time

+ NextEarliest *time.Time

+ Title *string

+ URL *string

+ type FetchConfig struct

+ AcceptLanguage string

+ Concurrency int

+ PerHostSerial bool

+ Timeout Duration

+ UserAgent string

+ func DefaultFetchConfig() FetchConfig

+ type FontConfig struct

+ CSSURL string

+ ChromeFamily string

+ ChromeSrc string

+ ContentFamily string

+ ContentSrc string

+ type Item struct

+ Author string

+ BodyHTML string

+ Categories []string

+ FeedID int64

+ FetchedAt time.Time

+ FullContent bool

+ GUID string

+ ID kid.ID

+ LeadImage string

+ Published time.Time

+ SummaryHTML string

+ Title string

+ URL string

+ WordCount int

+ func (it *Item) HasLink() bool

+ func (it *Item) ReadingTime() time.Duration

+ type ItemFilter struct

+ Categories []string

+ Limit int

+ Offset int

+ Since time.Time

+ type ItemService interface

+ FindItems func(ctx context.Context, filter ItemFilter) ([]*Item, int, error)

+ PurgeExpired func(ctx context.Context, olderThan time.Time) (int, error)

+ UpsertItems func(ctx context.Context, items []*Item) error

+ type OPML struct

+ Body OPMLBody

+ Head OPMLHead

+ Version string

+ XMLName xml.Name

+ func BuildOPML(cfg *Config, section string) *OPML

+ type OPMLBody struct

+ Outlines []Outline

+ type OPMLHead struct

+ Title string

+ type Outline struct

+ Children []Outline

+ Text string

+ Title string

+ Type string

+ XMLURL string

+ type Output struct

+ Body BodyScope

+ Categories []string

+ ExcerptImage ExcerptImage

+ File string

+ Health bool

+ InNav bool

+ Name string

+ ReadingTime *bool

+ Title string

+ func (o *Output) Filter(since time.Time) ItemFilter

+ func (o *Output) IsAll() bool

+ type OutputConf struct

+ Body BodyScope

+ Categories []string

+ ExcerptImage ExcerptImage

+ File string

+ Name string

+ ReadingTime *bool

+ Title string

+ type Settings struct

+ Body BodyScope

+ CacheDB string

+ CacheRetention Duration

+ DisplayWindow Duration

+ ExcerptImage ExcerptImage

+ ExcerptWords int

+ Highlight bool

+ HighlightTheme string

+ HighlightThemeDark string

+ NoteTemplate string

+ OutputDir string

+ ReadingTime bool

+ Theme string

+ Timezone string

+ Typography bool

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