Class BidsHedIssue

constructor

• new BidsHedIssue(hedIssue: Issue, file: object | null): BidsHedIssue

  Constructs a BidsHedIssue object.

  Direct use of this constructor is not recommended. Use BidsHedIssue.fromHedIssues.

  Parameters

  • hedIssue: Issue

    The HED issue object to be wrapped.

  • file: object | null

    The file object associated with this issue.

  Returns BidsHedIssue

code

file

hedIssue

issueMessage

line

location

severity

subCode

toString

• toString(): string

  Override of Object.prototype.toString.

  Returns string

  The issue message.

StaticaddIssueParameters

• addIssueParameters(issues: BidsHedIssue[], parameters: {}): void

  Add new parameters to the underlying HED issues of a list of BIDS issues and regenerate the issue messages.

  Parameters

  • issues: BidsHedIssue[]

    A list of BIDS-compatible issues.

  • parameters: {}

    The parameters to add.

  Returns void

StaticcategorizeByCode

• categorizeByCode(issues: BidsHedIssue[]): Map<string, BidsHedIssue[]>

  Categorize a list of issues by their subCode values.

  Parameters

  • issues: BidsHedIssue[]

    A list of BIDS HED issues.

  Returns Map<string, BidsHedIssue[]>

  A map where keys are HED issue codes and values are arrays of issues.

StaticfromHedIssue

• fromHedIssue(
      hedIssue: Issue,
      file: object | null,
      extraParameters?: {},
  ): BidsHedIssue

  Convert a single HED issue into a BIDS-compatible issue.

  Parameters

  • hedIssue: Issue

    A HED-format issue.

  • file: object | null

    A BIDS-format file object used to generate a BidsHedIssue object.

  • extraParameters: {} = {}

    Any extra parameters to inject into the Issue object.

  Returns BidsHedIssue

  The BIDS-compatible issue.

StaticfromHedIssues

• fromHedIssues(
      hedIssues: any,
      file: object | null,
      extraParameters?: {},
  ): BidsHedIssue[]

  Convert one or more HED issues into BIDS-compatible issues.

  Parameters

  • hedIssues: any

    One or more HED-format issues.

  • file: object | null

    A BIDS-format file object used to generate BidsHedIssue objects.

  • extraParameters: {} = {}

    Any extra parameters to inject into the Issue objects.

  Returns BidsHedIssue[]

  An array of BIDS-compatible issues.

StaticprocessIssues

• processIssues(
      issues: BidsHedIssue[],
      checkWarnings?: boolean,
      limitErrors?: boolean,
  ): BidsHedIssue[]

  Filter and reduce a list of issues based on severity and user options, producing a new list.

  If checkWarnings is true, warnings will be included in the output, otherwise only errors will be included. If limitErrors is true, the output will be reduced to one issue of each subCode type in the list. The message of each "representative" issue will be updated to summarize the number of occurrences and files.

  Parameters

  • issues: BidsHedIssue[]

    A list of BIDS HED issues.

  • checkWarnings: boolean = false

    Whether to include warnings in the output.

  • limitErrors: boolean = false

    Whether to reduce the list of issues to one of each type.

  Returns BidsHedIssue[]

  The processed list of issues.

StaticreduceIssues

• reduceIssues(issues: BidsHedIssue[]): BidsHedIssue[]

  Reduce a list of issues to one of each subCode that occurred in the incoming list, summarizing the occurrences.

  Parameters

  • issues: BidsHedIssue[]

    A list of BIDS HED issues.

  Returns BidsHedIssue[]

  A new list of issues with one issue of each type.

StaticsplitErrors

• splitErrors(issues: BidsHedIssue[]): Map<string, BidsHedIssue[]>

  Transform a list of issues into a Map, keyed by severity level.

  Parameters

  • issues: BidsHedIssue[]

    A list of BIDS HED issues.

  Returns Map<string, BidsHedIssue[]>

  A map where keys are severity levels and values are arrays of issues.

StatictransformToBids

• transformToBids(
      issues: (BidsHedIssue | Error)[],
      file?: object | null,
  ): BidsHedIssue[]

  Transform a list of mixed-format issues into BIDS-compatible issues.

  Parameters

  • issues: (BidsHedIssue | Error)[]

    A list of mixed-format issues.

  • file: object | null = null

    A BIDS-format file object used to generate BidsHedIssue objects.

  Returns BidsHedIssue[]

  An array of BIDS-compatible issues.