https://adz.github.io/FsFlow/reference/check/ Recent content in Check on FsFlow Hugo en-us https://adz.github.io/FsFlow/reference/check/m-checkmodule-all/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-all/ <p>Returns success when every check in the sequence succeeds.</p> <h2 id="remarks">Remarks</h2> <p>Sequentially evaluates each check in the <code>checks</code> sequence. Stops at the first failure.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>checks</code>: A sequence of checks.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> that succeeds only if all inputs succeed.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-and/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-and/ <p>Returns success when both checks succeed.</p> <h2 id="remarks">Remarks</h2> <p>This is a logical &ldquo;and&rdquo; operation. It short-circuits: if <code>left</code> fails, <code>right</code> is not evaluated.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>left</code>: The first check.</li> <li><code>right</code>: The second check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> that succeeds only if both inputs succeed.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-any/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-any/ <p>Returns success when at least one check in the sequence succeeds.</p> <h2 id="remarks">Remarks</h2> <p>Sequentially evaluates each check in the <code>checks</code> sequence. Stops at the first success.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>checks</code>: A sequence of checks.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> that succeeds if any input succeeds.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-blank/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-blank/ <p>Returns success when the string is blank.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>str</code>: The string to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> that succeeds if the string is blank.</p> https://adz.github.io/FsFlow/reference/check/t-check/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/t-check/ <p>A reusable predicate result that either preserves a value on success or acts as a gate with <code>unit</code> on success, while carrying a unit failure placeholder until the caller maps it into a domain-specific error.</p> <h2 id="remarks">Remarks</h2> <p>Use the <code>Check</code> module helpers to create and compose checks.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-equal/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-equal/ <p>Returns success when the values are equal.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>expected</code>: The expected value.</li> <li><code>actual</code>: The actual value.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> that succeeds if the values are equal.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-failif/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-failif/ <p>Returns success when the condition is false.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>cond</code>: The boolean condition to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> that succeeds if <code>cond</code> is false.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifblank/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifblank/ <p>Returns the string when it is blank.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>str</code>: The string to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> containing the blank string.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifempty/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifempty/ <p>Returns the sequence when it is not empty.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>coll</code>: The sequence to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> containing the non-empty sequence.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifemptystr/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifemptystr/ <p>Returns the string when it is null or empty.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>str</code>: The string to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> containing the empty or null string.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifequal/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifequal/ <p>Returns success when the values are equal.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>expected</code>: The expected value.</li> <li><code>actual</code>: The actual value.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> that succeeds if the values are equal.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifnone/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifnone/ <p>Returns the value when the option is <code>Some</code>.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>opt</code>: The option to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> containing the value if present.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifnonemptystr/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifnonemptystr/ <p>Returns success when the string is null or empty.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>str</code>: The string to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> that succeeds if the string is null or empty.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifnotblank/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifnotblank/ <p>Returns success when the string is blank.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>str</code>: The string to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> that succeeds if the string is blank.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifnotempty/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifnotempty/ <p>Returns success when the sequence is empty.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>coll</code>: The sequence to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> that succeeds if the sequence is empty.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifnotequal/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifnotequal/ <p>Returns success when the values are not equal.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>expected</code>: The expected value.</li> <li><code>actual</code>: The actual value.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> that succeeds if the values differ.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifnotnull/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifnotnull/ <p>Returns success when the value is null.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>value</code>: The value to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> that succeeds if the value is null.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifnull/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifnull/ <p>Returns the value when it is null.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>value</code>: The value to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> containing the null value.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifsome/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifsome/ <p>Returns success when the option is <code>None</code>.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>opt</code>: The option to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> that succeeds if the option is <code>None</code>.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifvaluenone/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifvaluenone/ <p>Returns the value when the value option is <code>ValueSome</code>.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>opt</code>: The value option to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> containing the value if present.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifvaluesome/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-failifvaluesome/ <p>Returns success when the value option is <code>ValueNone</code>.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>opt</code>: The value option to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> that succeeds if the value option is <code>ValueNone</code>.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-frompredicate/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-frompredicate/ <p>Builds a check from a predicate while preserving the successful value.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>predicate</code>: A function of type <code>'value -&gt; bool</code> to test the value.</li> <li><code>value</code>: The value of type <code>'value</code> to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> containing the value if the predicate succeeds.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-not/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-not/ <p>Returns success when the supplied check fails.</p> <h2 id="remarks">Remarks</h2> <p>This is a logical &ldquo;not&rdquo; operation for checks. Note that it discards the success value and returns <code>Unit</code> on success.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>check</code>: The source <code>Check</code> to invert.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> that succeeds if the input fails.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-notblank/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-notblank/ <p>Returns the string when it is not blank.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>str</code>: The string to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> containing the non-blank string.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-notempty/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-notempty/ <p>Returns the sequence when it is not empty.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>coll</code>: The sequence to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> containing the non-empty sequence.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-notequal/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-notequal/ <p>Returns success when the values are not equal.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>expected</code>: The expected value.</li> <li><code>actual</code>: The actual value.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> that succeeds if the values differ.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-notnull/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-notnull/ <p>Returns the value when it is not null.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>value</code>: The value to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> containing the non-null value.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-okif/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-okif/ <p>Returns success when the condition is true.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>cond</code>: The boolean condition to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> that succeeds if <code>cond</code> is true.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifblank/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifblank/ <p>Returns success when the string is blank.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>str</code>: The string to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> that succeeds if the string is null, empty, or whitespace.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifempty/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifempty/ <p>Returns success when the sequence is empty.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>coll</code>: The sequence to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> that succeeds if the sequence is empty.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifemptystr/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifemptystr/ <p>Returns success when the string is null or empty.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>str</code>: The string to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> that succeeds if the string is null or empty.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifequal/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifequal/ <p>Returns success when the values are equal.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>expected</code>: The expected value.</li> <li><code>actual</code>: The actual value.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> that succeeds if the values are equal.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifnone/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifnone/ <p>Returns success when the option is <code>None</code>.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>opt</code>: The option to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> that succeeds if the option is <code>None</code>.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifnonemptystr/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifnonemptystr/ <p>Returns the string when it is not null or empty.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>str</code>: The string to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> containing the non-empty string.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifnotblank/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifnotblank/ <p>Returns the string when it is not blank.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>str</code>: The string to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> containing the non-blank string.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifnotempty/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifnotempty/ <p>Returns the sequence when it is not empty.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>coll</code>: The sequence of type <code>seq&amp;lt;'a&amp;gt;</code> to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> containing the non-empty sequence.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifnotequal/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifnotequal/ <p>Returns success when the values are not equal.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>expected</code>: The expected value.</li> <li><code>actual</code>: The actual value.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> that succeeds if the values differ.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifnotnull/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifnotnull/ <p>Returns the value when it is not null.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>value</code>: The value of type <code>'a</code> to check for null.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> containing the non-null value.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifnull/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifnull/ <p>Returns success when the value is null.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>value</code>: The value to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> that succeeds if the value is null.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifsome/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifsome/ <p>Returns the value when the option is <code>Some</code>.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>opt</code>: The <code>FSharpOption</code> to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> containing the value if present.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifvaluenone/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifvaluenone/ <p>Returns success when the value option is <code>ValueNone</code>.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>opt</code>: The value option to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> that succeeds if the value option is <code>ValueNone</code>.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifvaluesome/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-okifvaluesome/ <p>Returns the value when the value option is <code>ValueSome</code>.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>opt</code>: The <code>FSharpValueOption</code> to check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> containing the value if present.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-or/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-or/ <p>Returns success when either check succeeds.</p> <h2 id="remarks">Remarks</h2> <p>This is a logical &ldquo;or&rdquo; operation. It short-circuits: if <code>left</code> succeeds, <code>right</code> is not evaluated.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>left</code>: The first check.</li> <li><code>right</code>: The second check.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Check</code> that succeeds if either input succeeds.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-orerror/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-orerror/ <p>Maps a unit error into the supplied application error value.</p> <h2 id="remarks">Remarks</h2> <p>This is the primary bridge from checks to domain-specific results.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>error</code>: The domain error of type <code>'error</code> to return on failure.</li> <li><code>result</code>: The source <code>Check</code>.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Result</code> with the provided error value.</p> https://adz.github.io/FsFlow/reference/check/m-checkmodule-orerrorwith/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/check/m-checkmodule-orerrorwith/ <p>Maps a unit error into an application error produced on demand.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>errorFn</code>: A function of type <code>unit -&gt; 'error</code> to produce the error.</li> <li><code>result</code>: The source <code>Check</code>.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Result</code> with the produced error value.</p>