Class BidsFile

A BIDS file.

Hierarchy (View Summary)

BidsFile
- BidsJsonFile
- BidsTsvFile

Index

Constructors

Properties

Accessors

hasHedData validatorClass

Methods

Constructors

constructor

new BidsFile(name: any, file: any, validatorClass: any): BidsFile
Parameters
- name: any
- file: any
- validatorClass: any
Returns BidsFile
- Defined in src/bids/types/file.js:33

Properties

file

file: any

The Object representing this file data. This is used to generate BidsHedIssue objects.

name

name: string

The name of this file.

Accessors

hasHedData

get hasHedData(): boolean
Determine whether this file has any HED data.

Returns boolean
- Defined in src/bids/types/file.js:75

validatorClass

get validatorClass(): Function
The validator class used to validate this file.

Returns Function
The validator class used to validate this file.
- Defined in src/bids/types/file.js:84

Methods

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.
- Defined in src/bids/types/file.js:45