Class Issue

constructor

• new Issue(
      internalCode: string,
      hedCode: string,
      level: string,
      parameters: {},
  ): Issue

  Constructor.

  Parameters

  • internalCode: string

    The internal error code.

  • hedCode: string

    The HED 3 error code.

  • level: string

    The issue level (error or warning).

  • parameters: {}

    The error string parameters.

  Returns Issue

_bounds

_parameters

hedCode

internalCode

level

StaticSPECIAL_PARAMETERS

bounds

• get bounds(): number[] | undefined

  Get the issue's bounds.

  Returns number[] | undefined

  The issue bounds within the parent string.

message

• get message(): string

  Generate the detailed error message.

  Returns string

  This issue's message.

parameters

• get parameters(): {}

  Get the issue parameters.

  Returns {}

  The issue parameters.

• set parameters(parameters: {}): void

  Set new parameters by converting all parameters except the substring bounds (an integer array) to their string forms.

  Parameters

  • parameters: {}

    The new issue parameters.

  Returns void

addParameter

• addParameter(name: string, value: any): void

  Add a new parameter value.

  Parameters

  • name: string

    The parameter name.

  • value: any

    The new parameter value.

  Returns void

addParameters

• addParameters(parameters: {}): void

  Add multiple parameters for this Issue.

  Parameters

  • parameters: {}

    The new values of the parameters.

  Returns void

generateMessage

• generateMessage(): void

  (Re-)generate the issue message.

  Returns void

  Deprecated

  The message is a getter computed from the current parameters, so there is nothing to regenerate.

hasParameter

• hasParameter(name: string): boolean

  Determine whether this issue has a given parameter.

  Parameters

  • name: string

    The parameter name to check.

  Returns boolean

  Whether this issue already has a parameter by that name.

toString

• toString(): string

  Override of Object.prototype.toString.

  Returns string

  This issue's message.