issues

class Issue(internalCode, hedCode, level, message)

A HED validation error or warning.

Constructor.

Arguments:

  • internalCode (string) – The internal error code.

  • hedCode (string) – The HED 3 error code.

  • level (string) – The issue level (error or warning).

  • message (string) – The detailed error message.

Issue.Issue

Constructor.

Issue.code

Note

Deprecated.

type: string

Also the internal error code.

TODO: This is kept for backward compatibility until the next major version bump.

Issue.hedCode

type: string

The HED 3 error code.

Issue.internalCode

type: string

The internal error code.

Issue.level

type: string

The issue level (error or warning).

Issue.message

type: string

The detailed error message.

Issue.toString()

Override of {@link Object.prototype.toString}.

Returns:

string – This issue’s message.

generateIssue(internalCode, parameters)

Generate a new issue object.

Arguments:

  • internalCode (string) – The internal error code.

  • parameters (Object.<string, (string|Array.<number>)>) – The error string parameters.

Returns:

Issue – An object representing the issue.