CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Module

utils/comparearrays

@ckeditor/ckeditor5-utils/src/comparearrays

module

Filtering

Type Definitions

Functions

  • compareArrays( a, b ) → ArrayRelation | number

    See source

    Compares how given arrays relate to each other. One array can be: same as another array, prefix of another array or completely different. If arrays are different, first index at which they differ is returned. Otherwise, a flag specifying the relation is returned. Flags are negative numbers, so whenever a number >= 0 is returned it means that arrays differ.

    compareArrays( [ 0, 2 ], [ 0, 2 ] );		// 'same'
compareArrays( [ 0, 2 ], [ 0, 2, 1 ] );		// 'prefix'
compareArrays( [ 0, 2 ], [ 0 ] );			// 'extension'
compareArrays( [ 0, 2 ], [ 1, 2 ] );		// 0
compareArrays( [ 0, 2 ], [ 0, 1 ] );		// 1

    Parameters

    a : readonly Array<unknown>

    Array that is compared.

    b : readonly Array<unknown>

    Array to compare with.

    Returns

    ArrayRelation | number

    How array a is related to b.