Class BidsFile

constructor

• new BidsFile(name: any, file: any, validatorClass: any): BidsFile

  Parameters

  • name: any
  • file: any
  • validatorClass: any

  Returns BidsFile

file

name

hasHedData

• get hasHedData(): boolean

  Determine whether this file has any HED data.

  Returns boolean

isTimelineFile

• get isTimelineFile(): boolean

  Whether this is a TSV file timeline file.

  Returns boolean

validatorClass

• get validatorClass(): Function

  The validator class used to validate this file.

  Returns Function

  The validator class used to validate this file.

validate

• validate(schemas: Schemas): BidsHedIssue[]

  Validate this validator's tsv file.

  Parameters

  • schemas: Schemas

    The HED schemas used to validate this file.

  Returns BidsHedIssue[]

  • Any issues found during validation of this TSV file.

StaticreadBidsFile

• readBidsFile(filePath: string): Promise<any[]>

  Read a BIDS file from a path.

  Parameters

  • filePath: string

    The actual path of the file.

  Returns Promise<any[]>

  A Promise that resolves to a two-element array containing the file contents and a mocked BIDS-type file object.

StaticreadBidsFileFromDatasetPath

• readBidsFileFromDatasetPath(
      datasetRoot: string,
      relativePath: string,
  ): Promise<any[]>

  Read a BIDS file from a relative path within a dataset.

  Parameters

  • datasetRoot: string

    The root path of the dataset.
  • relativePath: string

    The relative path of the file within the dataset.

  Returns Promise<any[]>

  A Promise that resolves to a two-element array containing the file contents and a mocked BIDS-type file object.