Class TezosDomainsValidator

An interface that defines functions for validating domain names.

Implements

DomainNameValidator

Index

Constructors

Accessors

Methods

addClaimableTld addSupportedTld isClaimableTld isValidWithKnownTld removeClaimableTld removeSupportedTld validateDomainName

Constructors

constructor

new TezosDomainsValidator(config?: TezosDomainsConfig): TezosDomainsValidator
Parameters
- Optionalconfig: TezosDomainsConfig
Returns TezosDomainsValidator

Accessors

supportedTLDs

get supportedTLDs(): string[]
Gets an array of supported top level domains.

Returns string[]
Implementation of DomainNameValidator.supportedTLDs

Methods

addClaimableTld

addClaimableTld(tld: string, validator: DomainNameValidatorFn): void
Parameters
- tld: string
- validator: DomainNameValidatorFn
Returns void

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
Implementation of DomainNameValidator.addSupportedTld

isClaimableTld

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

isValidWithKnownTld

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

removeClaimableTld

removeClaimableTld(tld: string): void
Parameters
- tld: string
Returns void

removeSupportedTld

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

validateDomainName

validateDomainName(
name: string,
options?: ValidateDomainNameOptions,
): DomainNameValidationResult
Validates whether the specified domain name is valid.
Parameters
- name: string
- options: ValidateDomainNameOptions = ...
Returns DomainNameValidationResult
Implementation of DomainNameValidator.validateDomainName