IOptionsMonitor<TOptions> Interface

Definition

Namespace:

Microsoft.Extensions.Options

Assembly:

Microsoft.Extensions.Options.dll

Package:

Microsoft.Extensions.Options v9.0.0

Source:

IOptionsMonitor.cs

Used for notifications when TOptions instances change.

generic <typename TOptions>
public interface class IOptionsMonitor

public interface IOptionsMonitor<out TOptions>

type IOptionsMonitor<'Options> = interface

Public Interface IOptionsMonitor(Of Out TOptions)

Type Parameters

TOptions

The options type.

This type parameter is covariant. That is, you can use either the type you specified or any type that is more derived. For more information about covariance and contravariance, see Covariance and Contravariance in Generics.

Derived

Microsoft.Extensions.Options.OptionsMonitor<TOptions>

Properties

CurrentValue

Returns the current TOptions instance with the DefaultName.

Methods

Get(String)	Returns a configured TOptions instance with the given name.
OnChange(Action<TOptions,String>)	Registers a listener to be called whenever a named TOptions changes.

Extension Methods

OnChange<TOptions>(IOptionsMonitor<TOptions>, Action<TOptions>)

Registers a listener to be called whenever TOptions changes.