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
21. 21
22. 22
23. 23
24. 24
25. 25
26. 26
27. 27

// SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com>
//
// SPDX-License-Identifier: Apache-2.0

import type {
	DirectoryReader,
	DocumentMetadata,
	FileReader,
} from "../types.ts";

/**
 * Skip this parser.
 * If no parsers left, do not include the file in a document tree.
 */
export interface Skip {
	readonly skip: true;
}

export interface MetadataParser {
	/**
	 * Parses a file or directory then returns metadata for the file or directory.
	 * Throws when the file or directory does not meet the expectation.
	 */
	parse(
		fileOrDirectory: FileReader | DirectoryReader,
	): Promise<DocumentMetadata | Skip>;
}