Class DeepDiffer

Deep difference generator for comparing JavaScript objects, arrays, and primitives.

This class provides comprehensive comparison capabilities with configurable output formatting and depth control.

Index

Constructors

Methods

diff updateConfig

Constructors

constructor

new DeepDiffer(config?: Partial<DeepDiffConfig>): DeepDiffer
Creates a new DeepDiffer instance
Parameters
- Optionalconfig: Partial<DeepDiffConfig>
  Optional configuration overrides
Returns DeepDiffer
- Defined in DeepDiff.ts:172

Methods

diff

diff<T = any>(oldValue: T, newValue: T): DeepDiffResult
Generate a deep diff between two values
Type Parameters
- T = any
Parameters
- oldValue: T
  The original value
- newValue: T
  The new value to compare against
Returns DeepDiffResult
Complete diff results including changes, summary, and formatted output
Example
```
const differ = new DeepDiffer({ includeUnchanged: true });
const result = differ.diff(
  { users: [{ id: 1, name: 'Alice' }] },
  { users: [{ id: 1, name: 'Alice Cooper' }] }
);
```
- Defined in DeepDiff.ts:199

updateConfig

updateConfig(config: Partial<DeepDiffConfig>): void
Update configuration options
Parameters
- config: Partial<DeepDiffConfig>
  Partial configuration to merge with existing config
Returns void
- Defined in DeepDiff.ts:237