NodeFileSystemFileHandle.d.ts 1.4 KB

12345678910111213141516171819202122232425262728
  1. import { NodeFileSystemHandle } from './NodeFileSystemHandle';
  2. import { NodeFileSystemWritableFileStream } from './NodeFileSystemWritableFileStream';
  3. import type { NodeFsaContext, NodeFsaFs } from './types';
  4. import type { IFileSystemFileHandle, IFileSystemSyncAccessHandle } from '../fsa/types';
  5. export declare class NodeFileSystemFileHandle extends NodeFileSystemHandle implements IFileSystemFileHandle {
  6. protected readonly fs: NodeFsaFs;
  7. readonly __path: string;
  8. protected readonly ctx: NodeFsaContext;
  9. constructor(fs: NodeFsaFs, __path: string, ctx?: Partial<NodeFsaContext>);
  10. /**
  11. * Returns a {@link Promise} which resolves to a {@link File} object
  12. * representing the state on disk of the entry represented by the handle.
  13. *
  14. * @see https://developer.mozilla.org/en-US/docs/Web/API/FileSystemFileHandle/getFile
  15. */
  16. getFile(): Promise<File>;
  17. /**
  18. * @see https://developer.mozilla.org/en-US/docs/Web/API/FileSystemFileHandle/createSyncAccessHandle
  19. */
  20. get createSyncAccessHandle(): undefined | (() => Promise<IFileSystemSyncAccessHandle>);
  21. /**
  22. * @see https://developer.mozilla.org/en-US/docs/Web/API/FileSystemFileHandle/createWritable
  23. */
  24. createWritable({ keepExistingData }?: CreateWritableOptions): Promise<NodeFileSystemWritableFileStream>;
  25. }
  26. export interface CreateWritableOptions {
  27. keepExistingData?: boolean;
  28. }