This is the archived documentation for Angular v6. Please visit angular.io to see documentation for the current version of Angular.
API > @angular/core

KeyValueDiffers

A repository of different Map diffing strategies used by NgClass, NgStyle, and others.

      
      class KeyValueDiffers {
  static create<S>(factories: KeyValueDifferFactory[], parent?: KeyValueDiffers): KeyValueDiffers
  static extend<S>(factories: KeyValueDifferFactory[]): StaticProvider
  constructor(factories: KeyValueDifferFactory[])
  factories: KeyValueDifferFactory[]
  find(kv: any): KeyValueDifferFactory
}

Static methods

create()

static create<S>(factories: KeyValueDifferFactory[], parent?: KeyValueDiffers): KeyValueDiffers
      
      static create<S>(factories: KeyValueDifferFactory[], parent?: KeyValueDiffers): KeyValueDiffers

Parameters

factories

Type: KeyValueDifferFactory[].
parent

Type: KeyValueDiffers.

Optional. Default is undefined.

Returns

KeyValueDiffers

extend()

Takes an array of KeyValueDifferFactory and returns a provider used to extend the inherited KeyValueDiffers instance with the provided factories and return a new KeyValueDiffers instance.
static extend<S>(factories: KeyValueDifferFactory[]): StaticProvider
      
      static extend<S>(factories: KeyValueDifferFactory[]): StaticProvider

Parameters

factories

Type: KeyValueDifferFactory[].

Returns

StaticProvider

Example

The following example shows how to extend an existing list of factories, which will only be applied to the injector for this component and its children. This step is all that's required to make a new KeyValueDiffer available.

@Component({ viewProviders: [ KeyValueDiffers.extend([new ImmutableMapDiffer()]) ] }) 
      
      @Component({
  viewProviders: [
    KeyValueDiffers.extend([new ImmutableMapDiffer()])
  ]
})

Constructor

constructor(factories: KeyValueDifferFactory[])
      
      constructor(factories: KeyValueDifferFactory[])

Parameters

factories

Type: KeyValueDifferFactory[].

Properties

Property Description
factories: KeyValueDifferFactory[]

Methods

find()

find(kv: any): KeyValueDifferFactory
      
      find(kv: any): KeyValueDifferFactory

Parameters

kv

Type: any.

Returns

KeyValueDifferFactory