Node.d.ts 3.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. import { FanOut } from 'thingies/lib/fanout';
  2. import { Buffer } from '@jsonjoy.com/fs-node-builtins/lib/internal/buffer';
  3. export type NodeEventModify = [type: 'modify'];
  4. export type NodeEventDelete = [type: 'delete'];
  5. export type NodeEvent = NodeEventModify | NodeEventDelete;
  6. /**
  7. * Node in a file system (like i-node, v-node).
  8. */
  9. export declare class Node {
  10. /**
  11. * @deprecated Subscribe to the volume-level `Superblock.changes` bus or use
  12. * `CoreWatcher` instead.
  13. */
  14. readonly changes: FanOut<NodeEvent>;
  15. ino: number;
  16. private _uid;
  17. private _gid;
  18. private _atime;
  19. private _mtime;
  20. private _ctime;
  21. private _btime;
  22. buf: Buffer;
  23. /** Total allocated memory capacity for this node. */
  24. private capacity;
  25. /** Actually used bytes to store content. */
  26. private size;
  27. rdev: number;
  28. mode: number;
  29. private _nlink;
  30. symlink: string;
  31. constructor(ino: number, mode?: number, uid?: number, gid?: number);
  32. set ctime(ctime: Date);
  33. get ctime(): Date;
  34. /**
  35. * Birth (creation) time of this node. Unlike `ctime`, it is set once when the
  36. * node is created and is never advanced by writes or metadata changes. The
  37. * setter exists only for restore paths, like snapshot deserialization.
  38. */
  39. set btime(btime: Date);
  40. get btime(): Date;
  41. set uid(uid: number);
  42. get uid(): number;
  43. set gid(gid: number);
  44. get gid(): number;
  45. set atime(atime: Date);
  46. get atime(): Date;
  47. set mtime(mtime: Date);
  48. get mtime(): Date;
  49. get perm(): number;
  50. set perm(perm: number);
  51. set nlink(nlink: number);
  52. get nlink(): number;
  53. getString(encoding?: BufferEncoding): string;
  54. setString(str: string): void;
  55. getBuffer(): Buffer;
  56. setBuffer(buf: Buffer): void;
  57. private _setBuf;
  58. getSize(): number;
  59. setModeProperty(property: number): void;
  60. isFile(): boolean;
  61. isDirectory(): boolean;
  62. isSymlink(): boolean;
  63. isCharacterDevice(): boolean;
  64. makeSymlink(symlink: string): void;
  65. write(buf: Buffer, off?: number, len?: number, pos?: number): number;
  66. /**
  67. * Read data from the file.
  68. *
  69. * @param buf Buffer to read data into.
  70. * @param off Offset int the `buf` where to start writing data.
  71. * @param len How many bytes to read. Equals to `buf.byteLength` by default.
  72. * @param pos Position offset in file where to start reading. Defaults to `0`.
  73. * @returns Returns the number of bytes read.
  74. */
  75. read(buf: Buffer | ArrayBufferView | DataView, off?: number, len?: number, pos?: number): number;
  76. truncate(len?: number): void;
  77. chmod(perm: number): void;
  78. chown(uid: number, gid: number): void;
  79. touch(): void;
  80. canRead(uid?: number, gid?: number): boolean;
  81. canWrite(uid?: number, gid?: number): boolean;
  82. canExecute(uid?: number, gid?: number): boolean;
  83. del(): void;
  84. toJSON(): {
  85. ino: number;
  86. uid: number;
  87. gid: number;
  88. atime: number;
  89. mtime: number;
  90. ctime: number;
  91. btime: number;
  92. perm: number;
  93. mode: number;
  94. nlink: number;
  95. symlink: string;
  96. data: string;
  97. };
  98. }