Skip to content
ConsoleMonster

API Reference

Class

DiffOptions

Namespace ConsoleMonster.Changes
Assembly ConsoleMonster
Modifiers sealed

Options for ObjectDiff.

Inheritance

  • Object
  • DiffOptions

Usage

Explore 2 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters 2

Constructors

public DiffOptions() #

Properties

public IList<String> Key { get; } #

The members whose values identify an object (like Compare-Object -Property for matching). Empty: Id, Name, Key...

public Func<Object, Object?>? KeySelector { get; set; } #

A function that returns an object's key, instead of DiffOptions.Key.

public IList<String> Properties { get; } #

The members to compare, or empty for all of them.

public IList<String> Ignore { get; } #

Members (or paths such as Address.City, with * wildcards) left out of the comparison.

public Int32 Depth { get; set; } #

How deep nested objects are compared (default 3).

public Boolean IncludeUnchanged { get; set; } #

Whether unchanged objects are listed too (they are always counted).

public Func<Object, Object>? Unwrap { get; set; } #

Turns a host wrapper into the value to compare (for example a PowerShell object around a dictionary), or null.

public TimeSpan TimeBudget { get; set; } #

How long getters may stall in one comparison before slow members stop being read (default 2 seconds).

public IList<IMemberSource> Sources { get; } #

Member sources tried before reflection (PowerShell objects, dictionaries, JSON).