NodeFileSystemHandle.d.ts 1.5 KB

123456789101112131415161718192021222324252627282930313233
  1. import { NodePermissionStatus } from './NodePermissionStatus';
  2. import type { IFileSystemHandle, FileSystemHandlePermissionDescriptor } from '../fsa/types';
  3. /**
  4. * Represents a File System Access API file handle `FileSystemHandle` object,
  5. * which was created from a Node.js `fs` module.
  6. *
  7. * @see [MDN Documentation](https://developer.mozilla.org/en-US/docs/Web/API/FileSystemHandle)
  8. */
  9. export declare abstract class NodeFileSystemHandle implements IFileSystemHandle {
  10. readonly kind: 'file' | 'directory';
  11. readonly name: string;
  12. constructor(kind: 'file' | 'directory', name: string);
  13. /**
  14. * Compares two handles to see if the associated entries (either a file or directory) match.
  15. *
  16. * @see https://developer.mozilla.org/en-US/docs/Web/API/FileSystemHandle/isSameEntry
  17. */
  18. isSameEntry(fileSystemHandle: NodeFileSystemHandle): boolean;
  19. /**
  20. * @see https://developer.mozilla.org/en-US/docs/Web/API/FileSystemHandle/queryPermission
  21. */
  22. queryPermission(fileSystemHandlePermissionDescriptor: FileSystemHandlePermissionDescriptor): NodePermissionStatus;
  23. /**
  24. * @see https://developer.mozilla.org/en-US/docs/Web/API/FileSystemHandle/remove
  25. */
  26. remove({ recursive }?: {
  27. recursive?: boolean;
  28. }): Promise<void>;
  29. /**
  30. * @see https://developer.mozilla.org/en-US/docs/Web/API/FileSystemHandle/requestPermission
  31. */
  32. requestPermission(fileSystemHandlePermissionDescriptor: FileSystemHandlePermissionDescriptor): NodePermissionStatus;
  33. }