Class BidsJsonFile

A BIDS JSON file.

Hierarchy (View Summary)

BidsFile
- BidsJsonFile
  - BidsSidecar

Index

Constructors

Properties

file jsonData name

Accessors

hasHedData validatorClass

Methods

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:75

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