Interface DomainNameValidator

An interface that defines functions for validating domain names.

interface DomainNameValidator {
    supportedTLDs: string[];
    addSupportedTld(tld: string, validator: DomainNameValidatorFn): void;
    isClaimableTld(tld: string): boolean;
    isValidWithKnownTld(name: string): DomainNameValidationResult;
    removeSupportedTld(tld: string): void;
    validateDomainName(
        name: string,
        options?: { minLevel: number },
    ): DomainNameValidationResult;
}

Implemented by

Index

Properties

Methods

addSupportedTld isClaimableTld isValidWithKnownTld removeSupportedTld validateDomainName

Properties

supportedTLDs

supportedTLDs: string[]

Gets an array of supported top level domains.

Methods

addSupportedTld

addSupportedTld(tld: string, validator: DomainNameValidatorFn): void
Adds a supported tld. You don't need to call this in most cases.
Parameters
- tld: string
- validator: DomainNameValidatorFn
Returns void

isClaimableTld

isClaimableTld(tld: string): boolean
Returns true if tld is supported by the OracleRegistrar
Parameters
- tld: string
Returns boolean

isValidWithKnownTld

isValidWithKnownTld(name: string): DomainNameValidationResult
Validates whether the specified domain name is valid and has a known TLD.
Parameters
- name: string
Returns DomainNameValidationResult

removeSupportedTld

removeSupportedTld(tld: string): void
Removes a supported tld. You don't need to call this in most cases.
Parameters
- tld: string
Returns void

validateDomainName

validateDomainName(
name: string,
options?: { minLevel: number },
): DomainNameValidationResult
Validates whether the specified domain name is valid.
Parameters
- name: string
- Optionaloptions: { minLevel: number }
Returns DomainNameValidationResult