snap

Documentation

Index

• func DecodeMultiSnapshots(raw []byte) (multiSnap, error)
• func EncodeMultiSnapshots(snaps multiSnap) ([]byte, error)
• func IsMultiSnapshots(filePath string) bool
• func ReadFile(path string) ([]byte, error)
• func RemoveFile(path string) error
• func SetLogger(slogr *slog.Logger)
• func SnapshotMatcher(snapFile string, options ...Option) *snapshotMatcher
• func WriteFile(path string, data []byte) error
• type DiffFunc
• type Option
  • func WithDiffFunc(f DiffFunc) Option
  • func WithSnapshotID(id string) Option

Functions

func DecodeMultiSnapshots

func DecodeMultiSnapshots(raw []byte) (multiSnap, error)

func EncodeMultiSnapshots

func EncodeMultiSnapshots(snaps multiSnap) ([]byte, error)

func IsMultiSnapshots

func IsMultiSnapshots(filePath string) bool

func ReadFile

func ReadFile(path string) ([]byte, error)

func RemoveFile

func RemoveFile(path string) error

func SetLogger

func SetLogger(slogr *slog.Logger)

func SnapshotMatcher

func SnapshotMatcher(snapFile string, options ...Option) *snapshotMatcher

SnapshotMatcher returns a matcher that compares the actual value with the snapshot file.

func WriteFile

func WriteFile(path string, data []byte) error

Types

type DiffFunc

type DiffFunc func(x, y string) string

type Option

type Option func(m *snapshotMatcher)

Option is a functional option for snapshotMatcher.

func WithDiffFunc

func WithDiffFunc(f DiffFunc) Option

func WithSnapshotID

func WithSnapshotID(id string) Option

WithSnapshotID is an option to specify the snapshot ID. If this option is set, the snapshot file is treated as a multi-snapshot file.