node.d.ts 4.0 KB

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