Abstract Class: Parser<T>

A parser signature that helps to organize the names accordingly.

Type Parameters

T

T = unknown

Constructors

Constructor

new Parser<T>(raw): Parser<T>

Constructs a custom parser accordingly.

Parameters

raw

T

data to be parsed

Returns

Parser<T>

Properties

raw

raw: T

Methods

parse()

abstract parse(options?): FullName

Parses raw data into a FullName while applying some options.

Parameters

options?

Partial<Config>

for additional configuration to apply.

Returns

FullName

---

build()

static build(text, index?): Parser

Builds a dynamic Parser on the fly and throws a NameError when unable to do so. The built parser only knows how to operate birth names.

Parameters

text

string

index?

NameIndex

Returns

Parser

---

buildAsync()

static buildAsync(text, index?): Promise<Parser<unknown>>

Builds asynchronously a dynamic Parser.

Parameters

text

string

index?

NameIndex

Returns

Promise<Parser<unknown>>