Check

This page shows the source-documented Check surface: the unit-failure result type and reusable predicate helpers.

Core type

• FsFlow.Check: A reusable predicate result that either preserves a value on success or acts as a gate with unit on success, while carrying a unit failure placeholder until the caller maps it into a domain-specific error.

Module functions

• FsFlow.CheckModule.fromPredicate: Builds a check from a predicate while preserving the successful value.
• FsFlow.CheckModule.not: Returns success when the supplied check fails.
• FsFlow.CheckModule.and: Returns success when both checks succeed.
• FsFlow.CheckModule.or: Returns success when either check succeeds.
• FsFlow.CheckModule.all: Returns success when every check in the sequence succeeds.
• FsFlow.CheckModule.any: Returns success when at least one check in the sequence succeeds.
• FsFlow.CheckModule.okIf: Returns success when the condition is true.
• FsFlow.CheckModule.failIf: Returns success when the condition is false.
• FsFlow.CheckModule.okIfSome: Returns the value when the option is Some.
• FsFlow.CheckModule.okIfNone: Returns success when the option is None.
• FsFlow.CheckModule.failIfSome: Returns success when the option is None.
• FsFlow.CheckModule.failIfNone: Returns the value when the option is Some.
• FsFlow.CheckModule.okIfValueSome: Returns the value when the value option is ValueSome.
• FsFlow.CheckModule.okIfValueNone: Returns success when the value option is ValueNone.
• FsFlow.CheckModule.failIfValueSome: Returns success when the value option is ValueNone.
• FsFlow.CheckModule.failIfValueNone: Returns the value when the value option is ValueSome.
• FsFlow.CheckModule.okIfNotNull: Returns the value when it is not null.
• FsFlow.CheckModule.okIfNull: Returns success when the value is null.
• FsFlow.CheckModule.failIfNotNull: Returns success when the value is null.
• FsFlow.CheckModule.failIfNull: Returns the value when it is null.
• FsFlow.CheckModule.okIfNotEmpty: Returns the sequence when it is not empty.
• FsFlow.CheckModule.okIfEmpty: Returns success when the sequence is empty.
• FsFlow.CheckModule.failIfNotEmpty: Returns success when the sequence is empty.
• FsFlow.CheckModule.failIfEmpty: Returns the sequence when it is not empty.
• FsFlow.CheckModule.okIfEqual: Returns success when the values are equal.
• FsFlow.CheckModule.okIfNotEqual: Returns success when the values are not equal.
• FsFlow.CheckModule.failIfEqual: Returns success when the values are equal.
• FsFlow.CheckModule.failIfNotEqual: Returns success when the values are not equal.
• FsFlow.CheckModule.okIfNonEmptyStr: Returns the string when it is not null or empty.
• FsFlow.CheckModule.okIfEmptyStr: Returns success when the string is null or empty.
• FsFlow.CheckModule.failIfNonEmptyStr: Returns success when the string is null or empty.
• FsFlow.CheckModule.failIfEmptyStr: Returns the string when it is null or empty.
• FsFlow.CheckModule.okIfNotBlank: Returns the string when it is not blank.
• FsFlow.CheckModule.notBlank: Returns the string when it is not blank.
• FsFlow.CheckModule.okIfBlank: Returns success when the string is blank.
• FsFlow.CheckModule.blank: Returns success when the string is blank.
• FsFlow.CheckModule.failIfNotBlank: Returns success when the string is blank.
• FsFlow.CheckModule.failIfBlank: Returns the string when it is blank.
• FsFlow.CheckModule.orError: Maps a unit error into the supplied application error value.
• FsFlow.CheckModule.orErrorWith: Maps a unit error into an application error produced on demand.
• FsFlow.CheckModule.notNull: Returns the value when it is not null.
• FsFlow.CheckModule.notEmpty: Returns the sequence when it is not empty.
• FsFlow.CheckModule.equal: Returns success when the values are equal.
• FsFlow.CheckModule.notEqual: Returns success when the values are not equal.