Class BidsFileAccessor

constructor

• new BidsFileAccessor(
      datasetRootDirectory: string,
      fileMap: Map<string, any>,
  ): BidsFileAccessor

  Constructs a BidsFileAccessor.

  Parameters

  • datasetRootDirectory: string

    The root directory of the dataset.
  • fileMap: Map<string, any>

    A map of relative file paths to file representations (e.g., File objects for web, full paths for Node.js).

  Returns BidsFileAccessor

datasetRootDirectory

fileMap

organizedPaths

StaticSPECIAL_DIRS

StaticSUFFIXES

getFileContent

• getFileContent(relativePath: string): Promise<string>

  Asynchronously reads the content of a file.

  This method must be implemented by subclasses to handle environment-specific file reading.

  Parameters

  • relativePath: string

    The relative path to the file.

  Returns Promise<string>

  A promise that resolves with the file content as a string, or null if the file cannot be read.

  Throws

  If the method is not implemented by a subclass.

Staticcreate

• create(datasetRootDirectory: any): Promise<BidsFileAccessor>

  Factory method to create a BidsFileAccessor.

  This method must be implemented by subclasses to handle environment-specific setup.

  Parameters

  • datasetRootDirectory: any

    The root directory of the dataset or a file-like object.

  Returns Promise<BidsFileAccessor>

  A Promise that resolves to a new BidsFileAccessor instance.

  Throws

  If the method is not implemented by a subclass.