[**@sankhyalabs/core**](../README.md) • **Docs**

***

[@sankhyalabs/core](../globals.md) / FieldComparator

# Class: FieldComparator

## Constructors

### new FieldComparator()

> **new FieldComparator**(): [`FieldComparator`](FieldComparator.md)

#### Returns

[`FieldComparator`](FieldComparator.md)

## Methods

### compare()

> `static` **compare**(`field`, `recordA`, `recordB`, `asc`, `onlyLabel`): `number`

#### Parameters

• **field**: [`FieldDescriptor`](../interfaces/FieldDescriptor.md)

• **recordA**: [`Record`](../interfaces/Record.md)

• **recordB**: [`Record`](../interfaces/Record.md)

• **asc**: `boolean`= `true`

• **onlyLabel**: `boolean`= `false`

#### Returns

`number`

#### Source

src/dataunit/sorting/FieldComparator.ts:7

***

### compareUndefined()

> `static` **compareUndefined**(`isUndefinedA`, `isUndefinedB`): `undefined` \| `number`

#### Parameters

• **isUndefinedA**: `boolean`

• **isUndefinedB**: `boolean`

#### Returns

`undefined` \| `number`

#### Source

src/dataunit/sorting/FieldComparator.ts:19

***

### compareValues()

> `static` **compareValues**(`descriptor`, `valueA`, `valueB`, `onlyLabel`): `number`

#### Parameters

• **descriptor**: [`FieldDescriptor`](../interfaces/FieldDescriptor.md)

• **valueA**: `any`

• **valueB**: `any`

• **onlyLabel**: `boolean`= `false`

#### Returns

`number`

#### Source

src/dataunit/sorting/FieldComparator.ts:14
