Validate Or Throw

Implement the Options Pattern with a single line of code, including validation on start and via Data Annotations.

Install

Install package tiaringhio.ValidateOrThrow from Nuget.
Here's how via command line:

Install-Package tiaringhio.ValidateOrThrow

Requirements

This package targets .NET standard 2.1 and above.

How To

The option class you want to be added and validated must inherit from the following interface:

public interface IValidatedOption { /// <summary> /// Name of the section in the appsettings.json (or secrets) file. /// </summary> public string SectionName { get; } }

Like so:

public class ExampleOption : IValidatedOption { public string SectionName => "Example"; }

Then you will be able to add you option as a singleton like so:

builder.Services.AddOptionsOrThrow<ExampleOption>();

Note that the extension will throw:

• a new InvalidOperationException when a section does not exist.
• a new OptionsValidationException when a requirement defined via Data Annotations is not met.