node.d.ts 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153
  1. import { Volume } from './volume';
  2. import { EventEmitter } from 'events';
  3. import Stats from './Stats';
  4. export declare const SEP = "/";
  5. /**
  6. * Node in a file system (like i-node, v-node).
  7. */
  8. export declare class Node extends EventEmitter {
  9. ino: number;
  10. private _uid;
  11. private _gid;
  12. private _atime;
  13. private _mtime;
  14. private _ctime;
  15. buf: Buffer;
  16. private _perm;
  17. mode: number;
  18. private _nlink;
  19. symlink: string[];
  20. constructor(ino: number, perm?: number);
  21. set ctime(ctime: Date);
  22. get ctime(): Date;
  23. set uid(uid: number);
  24. get uid(): number;
  25. set gid(gid: number);
  26. get gid(): number;
  27. set atime(atime: Date);
  28. get atime(): Date;
  29. set mtime(mtime: Date);
  30. get mtime(): Date;
  31. set perm(perm: number);
  32. get perm(): number;
  33. set nlink(nlink: number);
  34. get nlink(): number;
  35. getString(encoding?: string): string;
  36. setString(str: string): void;
  37. getBuffer(): Buffer;
  38. setBuffer(buf: Buffer): void;
  39. getSize(): number;
  40. setModeProperty(property: number): void;
  41. setIsFile(): void;
  42. setIsDirectory(): void;
  43. setIsSymlink(): void;
  44. isFile(): boolean;
  45. isDirectory(): boolean;
  46. isSymlink(): boolean;
  47. makeSymlink(steps: string[]): void;
  48. write(buf: Buffer, off?: number, len?: number, pos?: number): number;
  49. read(buf: Buffer | ArrayBufferView | DataView, off?: number, len?: number, pos?: number): number;
  50. truncate(len?: number): void;
  51. chmod(perm: number): void;
  52. chown(uid: number, gid: number): void;
  53. touch(): void;
  54. canRead(uid?: number, gid?: number): boolean;
  55. canWrite(uid?: number, gid?: number): boolean;
  56. del(): void;
  57. toJSON(): {
  58. ino: number;
  59. uid: number;
  60. gid: number;
  61. atime: number;
  62. mtime: number;
  63. ctime: number;
  64. perm: number;
  65. mode: number;
  66. nlink: number;
  67. symlink: string[];
  68. data: string;
  69. };
  70. }
  71. /**
  72. * Represents a hard link that points to an i-node `node`.
  73. */
  74. export declare class Link extends EventEmitter {
  75. vol: Volume;
  76. parent: Link;
  77. children: Map<string, Link | undefined>;
  78. private _steps;
  79. node: Node;
  80. ino: number;
  81. length: number;
  82. name: string;
  83. get steps(): string[];
  84. set steps(val: string[]);
  85. constructor(vol: Volume, parent: Link, name: string);
  86. setNode(node: Node): void;
  87. getNode(): Node;
  88. createChild(name: string, node?: Node): Link;
  89. setChild(name: string, link?: Link): Link;
  90. deleteChild(link: Link): void;
  91. getChild(name: string): Link | undefined;
  92. getPath(): string;
  93. getParentPath(): string;
  94. getName(): string;
  95. /**
  96. * Walk the tree path and return the `Link` at that location, if any.
  97. * @param steps {string[]} Desired location.
  98. * @param stop {number} Max steps to go into.
  99. * @param i {number} Current step in the `steps` array.
  100. *
  101. * @return {Link|null}
  102. */
  103. walk(steps: string[], stop?: number, i?: number): Link | null;
  104. toJSON(): {
  105. steps: string[];
  106. ino: number;
  107. children: string[];
  108. };
  109. syncSteps(): void;
  110. }
  111. /**
  112. * Represents an open file (file descriptor) that points to a `Link` (Hard-link) and a `Node`.
  113. */
  114. export declare class File {
  115. fd: number;
  116. /**
  117. * Hard link that this file opened.
  118. * @type {any}
  119. */
  120. link: Link;
  121. /**
  122. * Reference to a `Node`.
  123. * @type {Node}
  124. */
  125. node: Node;
  126. /**
  127. * A cursor/offset position in a file, where data will be written on write.
  128. * User can "seek" this position.
  129. */
  130. position: number;
  131. flags: number;
  132. /**
  133. * Open a Link-Node pair. `node` is provided separately as that might be a different node
  134. * rather the one `link` points to, because it might be a symlink.
  135. * @param link
  136. * @param node
  137. * @param flags
  138. * @param fd
  139. */
  140. constructor(link: Link, node: Node, flags: number, fd: number);
  141. getString(encoding?: string): string;
  142. setString(str: string): void;
  143. getBuffer(): Buffer;
  144. setBuffer(buf: Buffer): void;
  145. getSize(): number;
  146. truncate(len?: number): void;
  147. seekTo(position: number): void;
  148. stats(): Stats<number>;
  149. write(buf: Buffer, offset?: number, length?: number, position?: number | null): number;
  150. read(buf: Buffer | ArrayBufferView | DataView, offset?: number, length?: number, position?: number): number;
  151. chmod(perm: number): void;
  152. chown(uid: number, gid: number): void;
  153. }