Class BidsJsonFile

A BIDS JSON file.

Hierarchy (View Summary)

BidsFile
- BidsJsonFile
  - BidsSidecar

Index

Constructors

Properties

file jsonData name

Accessors

hasHedData isTimelineFile validatorClass

Methods

validate createFromBidsDatasetPath readBidsFile readBidsFileFromDatasetPath

Constructors

constructor

new BidsJsonFile(name: string, file: any, jsonData: any): BidsJsonFile
Constructor for a BIDS JSON file.

Note: This class is used for non-sidecars such as dataset_description.json and does not have a validation method.
Parameters
- name: string
  The name of the JSON file.
- file: any
  The file object representing this file.
- jsonData: any
  The JSON data for this file.
Returns BidsJsonFile
Overrides BidsFile.constructor
- Defined in src/bids/types/json.js:36

Properties

file

file: any

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

jsonData

jsonData: any

This file's JSON data.

name

name: string

The name of this file.

Accessors

hasHedData

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

Returns boolean
Inherited from BidsFile.hasHedData
- Defined in src/bids/types/file.js:110

isTimelineFile

get isTimelineFile(): boolean
Whether this is a TSV file timeline file.

Returns boolean
Inherited from BidsFile.isTimelineFile
- Defined in src/bids/types/file.js:101

validatorClass

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

Returns Function
The validator class used to validate this file.
Inherited from BidsFile.validatorClass
- Defined in src/bids/types/file.js:119

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.
Inherited from BidsFile.validate
- Defined in src/bids/types/file.js:71

`Static`createFromBidsDatasetPath

createFromBidsDatasetPath(
datasetRoot: string,
relativePath: string,
): Promise<BidsJsonFile>
Parse a BIDS JSON file from a BIDS dataset path.
Parameters
- datasetRoot: string
  The root path of the dataset.
- relativePath: string
  The relative path of the file within the dataset.
Returns Promise<BidsJsonFile>
The built JSON file object.
- Defined in src/bids/types/json.js:48

`Static`readBidsFile

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.
Inherited from BidsFile.readBidsFile
- Defined in src/bids/types/file.js:60

`Static`readBidsFileFromDatasetPath

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.
Inherited from BidsFile.readBidsFileFromDatasetPath
- Defined in src/bids/types/file.js:48