Interface CdigitAlgo

Readonly longName

Readonly name

compute

• compute(strWithoutCheckChars): string

• Generates the check characters from the argument using the algorithm. Unlike generate(), this method returns the check characters only.

  Parameters

  • strWithoutCheckChars: string

    A string without check characters.

  Returns string

  The check characters.

  Throws

  SyntaxError if an algorithm-specific syntax error occurs. Note that the bundled algorithm objects do not generally throw errors because they ignore the unknown letters in the string to be protected.

computeFromNumVals

• computeFromNumVals(numValsWithoutCheckChars): number[]

• Generates the check characters from the argument using the algorithm. This method is an alphabet-independent equivalent of compute(), where the return value and argument are both represented as arrays of each digit's numerical value.

  Parameters

  • numValsWithoutCheckChars: number[]

    A string without check characters decoded to an array of numerical values.

  Returns number[]

  The check characters decoded to an array of numerical values.

  Throws

  SyntaxError if the argument contains an invalid numerical value or any other algorithm-specific syntax error occurs.

generate

• generate(strWithoutCheckChars): string

• Generates the protected string from the argument using the algorithm. The generated string consists of the original bare string and computed check characters, which are combined in accordance with the algorithm.

  Parameters

  • strWithoutCheckChars: string

    A string without check characters.

  Returns string

  The string with check characters.

  Throws

  SyntaxError if an algorithm-specific syntax error occurs. Note that the bundled algorithm objects do not generally throw errors because they ignore the unknown letters in the string to be protected.

parse

• parse(strWithCheckChars): [string, string]

• Splits a protected string into the pair of original bare string and check characters.

  Parameters

  • strWithCheckChars: string

    A string with check characters.

  Returns [string, string]

  The tuple of [string without check characters, check characters].

  Throws

  SyntaxError if the argument does not contain check characters or any other algorithm-specific syntax error occurs. Note that the bundled algorithm objects do not generally throw errors because they ignore the unknown letters in the string to be protected.

validate

• validate(strWithCheckChars): boolean

• Checks if a protected string is valid per the algorithm.

  Parameters

  • strWithCheckChars: string

    A string with check characters.

  Returns boolean

  True if the argument is valid.

  Throws

  SyntaxError if the argument does not contain check characters or any other algorithm-specific syntax error occurs. Note that the bundled algorithm objects do not generally throw errors because they ignore the unknown letters in the string to be protected.