config

Documentation

Index

• Constants
• Variables
• type EmojiParams
• type Input
  • func (in *Input) IsValid() bool
  • func (in Input) Producer(fn func(string) error) error
• type ListFlags
  • func (lf ListFlags) FlagsPresent() bool
• type Output
  • func (out Output) FormatValid() bool
  • func (out Output) IsText() bool
• type Params
  • func (p *Params) CompileTemplates() (*template.Template, error)
  • func (p *Params) Logger() logger.Interface
  • func (p *Params) Validate() error
• type TimeValue
  • func (tv *TimeValue) Set(s string) error
  • func (tv *TimeValue) String() string

Constants

const (
	OutputTypeJSON = "json"
	OutputTypeText = "text"
)

const (
	FilenameTmplName = "fnt"
)

Variables

var (
	ErrInvalidInput = errors.New("no valid input")
)

var ErrNothingToDo = errors.New("no valid input and no list flags specified")

var ErrSkip = errors.New("skip")

ErrSkip is should be returned if the [Producer] should skip the channel.

Types

type EmojiParams

type EmojiParams struct {
	Enabled     bool
	FailOnError bool
}

type Input

type Input struct {
	List *structures.EntityList // Include channels
}

func (*Input) IsValid

func (in *Input) IsValid() bool

func (Input) Producer

func (in Input) Producer(fn func(string) error) error

Producer iterates over the list or reads the list from the file and calls fn for each entry.

type ListFlags

type ListFlags struct {
	Users    bool
	Channels bool
}

func (ListFlags) FlagsPresent

func (lf ListFlags) FlagsPresent() bool

type Output

type Output struct {
	Filename string
	Format   string // output format
	Base     string // base directory or zip file
}

func (Output) FormatValid

func (out Output) FormatValid() bool

func (Output) IsText

func (out Output) IsText() bool

type Params

type Params struct {
	ListFlags ListFlags

	Input  Input  // parameters of the input
	Output Output // " " output

	Oldest TimeValue // oldest time to dump conversations from
	Latest TimeValue // latest time to dump conversations to

	FilenameTemplate string

	ExportName  string            // export file or directory name.
	ExportType  export.ExportType // export type, see enum for available options.
	ExportToken string            // token that will be added to all exported files.

	Emoji EmojiParams

	Options slackdump.Options
}

Params is the application config parameters.

func (*Params) CompileTemplates

func (p *Params) CompileTemplates() (*template.Template, error)

func (*Params) Logger

func (p *Params) Logger() logger.Interface

func (*Params) Validate

func (p *Params) Validate() error

Validate checks if the command line parameters have valid values.

type TimeValue

type TimeValue time.Time

TimeValue satisfies flag.Value, used for command line parsing.

func (*TimeValue) Set

func (tv *TimeValue) Set(s string) error

func (*TimeValue) String

func (tv *TimeValue) String() string