data

package
v0.3.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 25, 2026 License: MIT Imports: 1 Imported by: 0

Documentation

Overview

Package data exports the type of the ReportData object in PatrolBot report templates.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ExpiryWindow

type ExpiryWindow struct {
	Count    int
	Duration config.Duration
}

An ExpiryWindow contains a duration of time and a count of the unpatrolled edits that will reach $wgRCMaxage and expire from Special:RecentChanges by the end of the given time period.

type PatrolExpiring

type PatrolExpiring struct {
	// Counts of edits expiring in specified time windows
	Windows []ExpiryWindow
}

PatrolExpiring contains counts of unpatrolled edits that will reach $wgRCMaxage within the given time windows.

type ReportData

type ReportData struct {
	// An error message indicating an error occurred while querying the MediaWiki API.
	Error string

	// Wiki configuration - URL, article path, etc.
	// The password field is redacted
	Config config.Wiki

	// Counts of unpatrolled edits in danger of aging out of Special:RecentChanges
	// [github.com/iocalebs/patrolbot/internal/config.ReportSources.PatrolExpiring] must be set for this data to be
	// sourced for the report
	PatrolExpiring PatrolExpiring
}

ReportData contains the data used to render a report template.

Jump to

Keyboard shortcuts

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