approvals

package module

Go to main page

Versions in this module

v1

v1.16.0

Oct 28, 2026

v1.15.0

Sep 16, 2026

v1.14.0

Jun 30, 2026

v1.13.0

Jun 30, 2026

v1.12.0

Jun 24, 2026

v1.11.0

Jun 8, 2026

v1.10.0

Apr 15, 2026

Changes in this version

+ func DefaultSanitizeFileName(fullPath string) string

+ type FileNameSanitizer func(string) string

+ var CurrentFileNameSanitizer FileNameSanitizer = DefaultSanitizeFileName

v1.9.1

Mar 20, 2026

Changes in this version

+ type FileOptions struct

+ func (f FileOptions) GetExtension() string

+ func (f FileOptions) GetNamer() core.ApprovalNamerCreator

+ func (f FileOptions) WithAdditionalInformation(info string) VerifyOptions

+ func (f FileOptions) WithExtension(extensionWithDot string) VerifyOptions

+ func (f FileOptions) WithNamer(namer core.ApprovalNamerCreator) VerifyOptions

+ type Scrubber func(s string) string

v1.8.0

Feb 11, 2026

v1.7.0

Jan 28, 2026

Changes in this version

+ func CreateJSONScrubber(label string, valueMatcher *regexp.Regexp) scrubber

+ type VerifyOptions struct

+ func (v VerifyOptions) AddScrubber(scrubfn scrubber) VerifyOptions

+ func (v VerifyOptions) ForFile() fileOptions

+ func (v VerifyOptions) GetExtension() string

+ func (v VerifyOptions) Scrub(reader io.Reader) (io.Reader, error)

+ func (v VerifyOptions) WithExtension(extension string) VerifyOptions

+ func (v VerifyOptions) WithRegexScrubber(regex *regexp.Regexp, replacer string) VerifyOptions

+ func (v VerifyOptions) WithScrubber(scrub scrubber) VerifyOptions

v1.6.2

Nov 4, 2025

Changes in this version

+ func AddDateScrubber(example string, regex string, displayMessage ...bool) error

+ func ClearCustomDateScrubbers()

+ type ConsoleOutput struct

+ func NewConsoleOutput() *ConsoleOutput

+ func (c *ConsoleOutput) Close() error

+ func (c *ConsoleOutput) GetError() string

+ func (c *ConsoleOutput) GetOutput() string

+ func (c *ConsoleOutput) VerifyAll(t core.Failable)

+ func (c *ConsoleOutput) VerifyError(t core.Failable)

+ func (c *ConsoleOutput) VerifyOutput(t core.Failable)

v1.6.0

Jul 16, 2025

v1.5.1

May 16, 2025

Changes in this version

+ type TestFailable struct

+ func NewTestFailableWithName(name string) *TestFailable

+ func (s *TestFailable) Error(args ...interface{})

+ func (s *TestFailable) Failed() bool

+ func (s *TestFailable) Helper()

+ func (s *TestFailable) Name() string

v1.5.0

Apr 23, 2025

v1.4.0

Apr 9, 2025

v1.3.0

Apr 3, 2025

v1.2.1

Mar 27, 2025

v1.2.0

Feb 12, 2025

Changes in this version

+ func CreateTemplatedCustomNamerCreator(template string) core.ApprovalNamerCreator

+ func NewTemplatedCustomNamer(t core.Failable, template string) *templatedCustomNamer

v1.1.1

Feb 6, 2025

Changes in this version

type ApprovalName

+ func (s *ApprovalName) GetApprovalFile(extWithDot string) string

+ func (s *ApprovalName) GetName() string

+ func (s *ApprovalName) GetReceivedFile(extWithDot string) string

v1.1.0

Jan 30, 2025

Changes in this version

+ func GetApprovedFileLoggerInstance() *approvedFileLog

v1.0.0

Jan 30, 2025

Changes in this version

+ const SkipThisCombination

+ func CreateGuidScrubber() scrubber

+ func CreateMultiScrubber(scrubbers ...scrubber) scrubber

+ func CreateNoopScrubber() scrubber

+ func CreateRegexScrubber(regex *regexp.Regexp, replacer string) scrubber

+ func CreateRegexScrubberWithLabeler(regex *regexp.Regexp, replacer func(int) string) scrubber

+ func GetDateScrubberFor(formattedExample string) (scrubber, error)

+ func GetSupportedFormatsRegex() []string

+ func NewDateScrubber(pattern string) scrubber

+ func NewVerifyOptions(fields map[string]interface{}, key string, value interface{}) verifyOptions

+ func Options() verifyOptions

+ func UseFolder(f string)

+ func UseFrontLoadedReporter(reporter reporters.Reporter) io.Closer

+ func UseReporter(reporter reporters.Reporter) io.Closer

+ func Verify(t Failable, reader io.Reader, opts ...verifyOptions)

+ func VerifyAll(t Failable, header string, collection interface{}, ...)

+ func VerifyAllCombinationsFor1(t Failable, header string, transform func(interface{}) string, ...)

+ func VerifyAllCombinationsFor2(t Failable, header string, transform func(p1, p2 interface{}) string, ...)

+ func VerifyAllCombinationsFor3(t Failable, header string, transform func(p1, p2, p3 interface{}) string, ...)

+ func VerifyAllCombinationsFor4(t Failable, header string, transform func(p1, p2, p3, p4 interface{}) string, ...)

+ func VerifyAllCombinationsFor5(t Failable, header string, ...)

+ func VerifyAllCombinationsFor6(t Failable, header string, ...)

+ func VerifyAllCombinationsFor7(t Failable, header string, ...)

+ func VerifyAllCombinationsFor8(t Failable, header string, ...)

+ func VerifyAllCombinationsFor9(t Failable, header string, ...)

+ func VerifyArray(t Failable, array interface{}, opts ...verifyOptions)

+ func VerifyJSONBytes(t Failable, bs []byte, opts ...verifyOptions)

+ func VerifyJSONStruct(t Failable, obj interface{}, opts ...verifyOptions)

+ func VerifyMap(t Failable, m interface{}, opts ...verifyOptions)

+ func VerifyString(t Failable, s string, opts ...verifyOptions)

+ func VerifyWithExtension(t Failable, reader io.Reader, extWithDot string, opts ...verifyOptions)

+ func VerifyXMLBytes(t Failable, bs []byte, opts ...verifyOptions)

+ func VerifyXMLStruct(t Failable, obj interface{}, opts ...verifyOptions)

+ type ApprovalName struct

+ func NewApprovalName(name string, fileName string) ApprovalName

+ type DateScrubber struct

+ type Failable interface

+ Fail func()

+ Fatal func(args ...interface{})

+ Fatalf func(format string, args ...interface{})

+ Helper func()

+ Log func(args ...interface{})

+ Logf func(format string, args ...interface{})

+ Name func() string

+ type SupportedFormat struct

+ Examples []string

+ Regex string

+ func GetSupportedFormats() []SupportedFormat

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