CodoMetis.TypeKit.Testing
1.5.0
Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package CodoMetis.TypeKit.Testing --version 1.5.0
NuGet\Install-Package CodoMetis.TypeKit.Testing -Version 1.5.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="CodoMetis.TypeKit.Testing" Version="1.5.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="CodoMetis.TypeKit.Testing" Version="1.5.0" />
<PackageReference Include="CodoMetis.TypeKit.Testing" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add CodoMetis.TypeKit.Testing --version 1.5.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: CodoMetis.TypeKit.Testing, 1.5.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package CodoMetis.TypeKit.Testing@1.5.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=CodoMetis.TypeKit.Testing&version=1.5.0
#tool nuget:?package=CodoMetis.TypeKit.Testing&version=1.5.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
CodoMetis.TypeKit.Testing
Test assertions for the Option and Result of
CodoMetis.TypeKit. Neither type has a .Value, so a
test reaches the content through these, and fails with what the outcome was instead.
dotnet add package CodoMetis.TypeKit.Testing # the test project
using CodoMetis.TypeKit.Testing;
Email email = Email.Create("ops@example.com").ShouldBeSuccess(); // the value, for the test's own assertions
Email.Create("nobody").ShouldBeError(EmailFault.NoAt); // this error, or the test fails
EmailFault fault = Email.Create("").ShouldBeError(); // any error, handed back
Email.TryFrom("ops@example.com").ShouldBeSome();
Email.TryFrom("nobody").ShouldBeNone();
- The content comes back.
ShouldBeSome(),ShouldBeSuccess()andShouldBeError()return the value or the error, so it is compared with whatever assertions the test already uses: xUnit'sAssert, Shouldly, or another. - No test framework. A failure is a
TypeKitAssertionException, and every framework reports an exception from a test as its failure. The package depends onCodoMetis.TypeKitalone. - A failure says what the outcome was:
Expected a success, but the Result<Email, EmailFault> is the error NoAt.It names the error, which is what a test needs to see, and never prints a value, asOptionandResultthemselves never do. - An uninitialized result fails every assertion, saying it is a default instance, neither a success nor an error.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- CodoMetis.TypeKit (>= 1.5.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.