Function: analyzeDomain()

function analyzeDomain(
  domain: string,
  options?: DomainOptions,
): Analysis | null;

Analyzes a string to verify it is a valid domain name.

Parameters

Parameter	Type	Description
domain	string	the domain name to validate.
options?	DomainOptions	optional settings.

Returns

Analysis | null

• undefined when valid, otherwise an object with single error key with a string message value.