cleaner

Documentation

Overview

Package cleaner provides functions to clean old .ts files.

Index

• func Clean(scanDirectory string, opts ...Option) error
• func CleanPeriodically(ctx context.Context, scanDirectory string, interval time.Duration, ...)
• func Scan(scanDirectory string, opts ...Option) (queueForDeletion []string, queueForRenaming []string, err error)
• type Option
  • func WithDryRun() Option
  • func WithEligibleAge(d time.Duration) Option
  • func WithoutProbe() Option
• type Options

Functions

func Clean

func Clean(scanDirectory string, opts ...Option) error

Clean removes old .ts files from the scanDirectory.

func CleanPeriodically

func CleanPeriodically(
	ctx context.Context,
	scanDirectory string,
	interval time.Duration,
	opts ...Option,
)

CleanPeriodically runs the Clean function periodically.

func Scan

func Scan(
	scanDirectory string,
	opts ...Option,
) (queueForDeletion []string, queueForRenaming []string, err error)

Scan scans the scanDirectory for old .ts files.

Types

type Option

type Option func(*Options)

Option is the option for the cleaner.

func WithDryRun

func WithDryRun() Option

WithDryRun sets the dryRun option.

func WithEligibleAge

func WithEligibleAge(d time.Duration) Option

WithEligibleAge sets the minimum time since the modtime of the file to be deleted.

func WithoutProbe

func WithoutProbe() Option

WithoutProbe disables the probe.

type Options

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

Options are the options for the cleaner.