ananoid 1.1.0


AlphabetError Type

Details the potential failures which can occur when an a letter set is validated during Alphabet creation.

Union cases

Union case Description

AlphabetTooLarge Source

Full Usage: AlphabetTooLarge Source

Parameters:
    Source : string

Raised when an alphabet contains more than 255 letters.

Source : string

AlphabetTooSmall Source

Full Usage: AlphabetTooSmall Source

Parameters:
    Source : string

Raised when an alphabet contains no letters.

Source : string

Instance members

Instance member Description

this.Letters

Full Usage: this.Letters

Returns: string

The letter set which generated the current error.

Returns: string

this.Message

Full Usage: this.Message

Returns: string

A human-readable description of the error, suitable for printing.

Returns: string

this.Promote

Full Usage: this.Promote

Returns: 'T

Creates an AlphabetException from the current AlphabetError instance. The newly created exception is then raised.

Returns: 'T
AlphabetException Raised as the intended consequence of invoking this method.