Skip to main content
Version: 2.2.0

Class: NameIndex

A set of values to handle specific positions for list of names.

As for list of names, this helps to follow a specific order based on the count of elements. It is expected that the list has to be between two and five elements. Also, the order of appearance set in the configuration influences how the parsing is carried out.

Ordered by first name, the parser works as follows:

  • 2 elements: firstName lastName
  • 3 elements: firstName middleName lastName
  • 4 elements: prefix firstName middleName lastName
  • 5 elements: prefix firstName middleName lastName suffix

Ordered by last name, the parser works as follows:

  • 2 elements: lastName firstName
  • 3 elements: lastName firstName middleName
  • 4 elements: prefix lastName firstName middleName
  • 5 elements: prefix lastName firstName middleName suffix

For example, Jane Smith (ordered by first name) is expected to be indexed: ['Jane', 'Smith'].

Constructors​

Constructor​

protected new NameIndex(prefix, firstName, middleName, lastName, suffix): NameIndex

Parameters​

prefix​

number

firstName​

number

middleName​

number

lastName​

number

suffix​

number

Returns​

NameIndex

Properties​

firstName​

readonly firstName: number

json​

json: () => Record<string, number>

Returns​

Record<string, number>

lastName​

readonly lastName: number

middleName​

readonly middleName: number

prefix​

readonly prefix: number

suffix​

readonly suffix: number

Accessors​

max​

Get Signature​

get static max(): number

The maximum number of parts in a list of names.

Returns​

number

min​

Get Signature​

get static min(): number

The minimum number of parts in a list of names.

Returns​

number

Methods​

toJson()​

toJson(): Record<string, number>

Returns​

Record<string, number>

base()​

static base(): NameIndex

The default or base indexing: firstName lastName.

Returns​

NameIndex

only()​

static only(__namedParameters): NameIndex

Parameters​

__namedParameters​

Record<string, number>

Returns​

NameIndex

when()​

static when(order, count?): NameIndex

Gets the name index for a list of names based on the count of elements and their order of appearance.

Parameters​

order​

NameOrder

count?​

number

Returns​

NameIndex