macana

Static site generator for Obsidian Vault

  1. 1
  2. 2
  3. 3
  4. 4
  5. 5
  6. 6
  7. 7
  8. 8
  9. 9
  10. 10
  11. 11
  12. 12
  13. 13
  14. 14
  15. 15
  16. 16
  17. 17
  18. 18
  19. 19
  20. 20
// SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com>
//
// SPDX-License-Identifier: Apache-2.0

import type { RootDirectoryReader } from "../types.ts";

export interface FileSystemReader {
	/**
	 * Returns the topmost directory this FileSystem Reader can operate on.
	 */
	getRootDirectory(): Promise<RootDirectoryReader>;

	/**
	 * Directly read file contents at given path.
	 * Throws if path does not exist or found directory.
	 * You should traverse from `getRootDirectory()` for most cases.
	 * @deprecated Use `RootDirectoryReader.openFile` then `FileReader.read` instead.
	 */
	readFile(path: readonly string[]): Promise<Uint8Array>;
}