typescript-virtual-container 1.4.4 → 1.4.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (884) hide show
  1. package/README.md +1 -1
  2. package/builds/self-standalone.js +321 -272
  3. package/builds/self-standalone.js.map +4 -4
  4. package/builds/standalone-wo-sftp.js +262 -212
  5. package/builds/standalone-wo-sftp.js.map +4 -4
  6. package/builds/standalone.cjs +491 -0
  7. package/builds/standalone.cjs.map +7 -0
  8. package/builds/standalone.js +266 -216
  9. package/builds/standalone.js.map +4 -4
  10. package/builds/web-full-api.min.js +5 -5
  11. package/builds/web-full-api.min.js.map +3 -3
  12. package/builds/web.min.js +5 -5
  13. package/builds/web.min.js.map +3 -3
  14. package/bun.lock +97 -0
  15. package/dist/Honeypot/index.d.ts.map +1 -0
  16. package/dist/Honeypot/index.js +299 -0
  17. package/dist/Honeypot/index.js.map +1 -0
  18. package/dist/SSHClient/index.d.ts.map +1 -0
  19. package/dist/SSHClient/index.js +238 -0
  20. package/dist/SSHClient/index.js.map +1 -0
  21. package/dist/SSHMimic/exec.d.ts.map +1 -0
  22. package/dist/SSHMimic/exec.js +28 -0
  23. package/dist/SSHMimic/exec.js.map +1 -0
  24. package/dist/SSHMimic/executor.d.ts.map +1 -0
  25. package/dist/SSHMimic/executor.js +161 -0
  26. package/dist/SSHMimic/executor.js.map +1 -0
  27. package/dist/SSHMimic/hostKey.d.ts.map +1 -0
  28. package/dist/SSHMimic/hostKey.js +18 -0
  29. package/dist/SSHMimic/hostKey.js.map +1 -0
  30. package/dist/SSHMimic/index.d.ts.map +1 -0
  31. package/dist/SSHMimic/index.js +250 -0
  32. package/dist/SSHMimic/index.js.map +1 -0
  33. package/dist/SSHMimic/loginBanner.d.ts.map +1 -0
  34. package/dist/SSHMimic/loginBanner.js +23 -0
  35. package/dist/SSHMimic/loginBanner.js.map +1 -0
  36. package/dist/SSHMimic/loginFormat.d.ts.map +1 -0
  37. package/dist/SSHMimic/loginFormat.js +11 -0
  38. package/dist/SSHMimic/loginFormat.js.map +1 -0
  39. package/dist/SSHMimic/prompt.d.ts.map +1 -0
  40. package/dist/SSHMimic/prompt.js +10 -0
  41. package/dist/SSHMimic/prompt.js.map +1 -0
  42. package/dist/SSHMimic/sftp.d.ts.map +1 -0
  43. package/dist/SSHMimic/sftp.js +620 -0
  44. package/dist/SSHMimic/sftp.js.map +1 -0
  45. package/dist/VirtualFileSystem/binaryPack.d.ts.map +1 -0
  46. package/dist/VirtualFileSystem/binaryPack.js +217 -0
  47. package/dist/VirtualFileSystem/binaryPack.js.map +1 -0
  48. package/dist/VirtualFileSystem/index.d.ts.map +1 -0
  49. package/dist/VirtualFileSystem/index.js +690 -0
  50. package/dist/VirtualFileSystem/index.js.map +1 -0
  51. package/dist/VirtualFileSystem/internalTypes.d.ts.map +1 -0
  52. package/dist/VirtualFileSystem/internalTypes.js +1 -0
  53. package/dist/VirtualFileSystem/internalTypes.js.map +1 -0
  54. package/dist/VirtualFileSystem/path.d.ts.map +1 -0
  55. package/dist/VirtualFileSystem/path.js +50 -0
  56. package/dist/VirtualFileSystem/path.js.map +1 -0
  57. package/dist/VirtualPackageManager/index.d.ts.map +1 -0
  58. package/dist/VirtualPackageManager/index.js +854 -0
  59. package/dist/VirtualPackageManager/index.js.map +1 -0
  60. package/dist/VirtualShell/index.d.ts.map +1 -0
  61. package/dist/VirtualShell/index.js +285 -0
  62. package/dist/VirtualShell/index.js.map +1 -0
  63. package/dist/VirtualShell/shell.d.ts.map +1 -0
  64. package/dist/VirtualShell/shell.js +503 -0
  65. package/dist/VirtualShell/shell.js.map +1 -0
  66. package/dist/VirtualShell/shellParser.d.ts.map +1 -0
  67. package/dist/VirtualShell/shellParser.js +266 -0
  68. package/dist/VirtualShell/shellParser.js.map +1 -0
  69. package/dist/VirtualUserManager/index.d.ts.map +1 -0
  70. package/dist/VirtualUserManager/index.js +608 -0
  71. package/dist/VirtualUserManager/index.js.map +1 -0
  72. package/dist/commands/adduser.d.ts.map +1 -0
  73. package/dist/commands/adduser.js +90 -0
  74. package/dist/commands/adduser.js.map +1 -0
  75. package/dist/commands/alias.d.ts.map +1 -0
  76. package/dist/commands/alias.js +69 -0
  77. package/dist/commands/alias.js.map +1 -0
  78. package/dist/commands/apt.d.ts.map +1 -0
  79. package/dist/commands/apt.js +211 -0
  80. package/dist/commands/apt.js.map +1 -0
  81. package/dist/commands/awk.d.ts.map +1 -0
  82. package/dist/commands/awk.js +170 -0
  83. package/dist/commands/awk.js.map +1 -0
  84. package/dist/commands/base64.d.ts.map +1 -0
  85. package/dist/commands/base64.js +29 -0
  86. package/dist/commands/base64.js.map +1 -0
  87. package/dist/commands/cat.d.ts.map +1 -0
  88. package/dist/commands/cat.js +45 -0
  89. package/dist/commands/cat.js.map +1 -0
  90. package/dist/commands/cd.d.ts.map +1 -0
  91. package/dist/commands/cd.js +22 -0
  92. package/dist/commands/cd.js.map +1 -0
  93. package/dist/commands/chmod.d.ts.map +1 -0
  94. package/dist/commands/chmod.js +88 -0
  95. package/dist/commands/chmod.js.map +1 -0
  96. package/dist/commands/clear.d.ts.map +1 -0
  97. package/dist/commands/clear.js +14 -0
  98. package/dist/commands/clear.js.map +1 -0
  99. package/dist/commands/command-helpers.d.ts.map +1 -0
  100. package/dist/commands/command-helpers.js +222 -0
  101. package/dist/commands/command-helpers.js.map +1 -0
  102. package/dist/commands/cp.d.ts.map +1 -0
  103. package/dist/commands/cp.js +76 -0
  104. package/dist/commands/cp.js.map +1 -0
  105. package/dist/commands/curl.d.ts.map +1 -0
  106. package/dist/commands/curl.js +128 -0
  107. package/dist/commands/curl.js.map +1 -0
  108. package/dist/commands/cut.d.ts.map +1 -0
  109. package/dist/commands/cut.js +35 -0
  110. package/dist/commands/cut.js.map +1 -0
  111. package/dist/commands/date.d.ts.map +1 -0
  112. package/dist/commands/date.js +29 -0
  113. package/dist/commands/date.js.map +1 -0
  114. package/dist/commands/declare.d.ts.map +1 -0
  115. package/dist/commands/declare.js +45 -0
  116. package/dist/commands/declare.js.map +1 -0
  117. package/dist/commands/deluser.d.ts.map +1 -0
  118. package/dist/commands/deluser.js +84 -0
  119. package/dist/commands/deluser.js.map +1 -0
  120. package/dist/commands/df.d.ts.map +1 -0
  121. package/dist/commands/df.js +22 -0
  122. package/dist/commands/df.js.map +1 -0
  123. package/dist/commands/diff.d.ts.map +1 -0
  124. package/dist/commands/diff.js +46 -0
  125. package/dist/commands/diff.js.map +1 -0
  126. package/dist/commands/dpkg.d.ts.map +1 -0
  127. package/dist/commands/dpkg.js +162 -0
  128. package/dist/commands/dpkg.js.map +1 -0
  129. package/dist/commands/du.d.ts.map +1 -0
  130. package/dist/commands/du.js +51 -0
  131. package/dist/commands/du.js.map +1 -0
  132. package/dist/commands/echo.d.ts.map +1 -0
  133. package/dist/commands/echo.js +46 -0
  134. package/dist/commands/echo.js.map +1 -0
  135. package/dist/commands/env.d.ts.map +1 -0
  136. package/dist/commands/env.js +21 -0
  137. package/dist/commands/env.js.map +1 -0
  138. package/dist/commands/exit.d.ts.map +1 -0
  139. package/dist/commands/exit.js +17 -0
  140. package/dist/commands/exit.js.map +1 -0
  141. package/dist/commands/export.d.ts.map +1 -0
  142. package/dist/commands/export.js +34 -0
  143. package/dist/commands/export.js.map +1 -0
  144. package/dist/commands/find.d.ts.map +1 -0
  145. package/dist/commands/find.js +56 -0
  146. package/dist/commands/find.js.map +1 -0
  147. package/dist/commands/free.d.ts.map +1 -0
  148. package/dist/commands/free.js +44 -0
  149. package/dist/commands/free.js.map +1 -0
  150. package/dist/commands/grep.d.ts.map +1 -0
  151. package/dist/commands/grep.js +121 -0
  152. package/dist/commands/grep.js.map +1 -0
  153. package/dist/commands/groups.d.ts.map +1 -0
  154. package/dist/commands/groups.js +18 -0
  155. package/dist/commands/groups.js.map +1 -0
  156. package/dist/commands/gzip.d.ts.map +1 -0
  157. package/dist/commands/gzip.js +83 -0
  158. package/dist/commands/gzip.js.map +1 -0
  159. package/dist/commands/head.d.ts.map +1 -0
  160. package/dist/commands/head.js +47 -0
  161. package/dist/commands/head.js.map +1 -0
  162. package/dist/commands/help.d.ts.map +1 -0
  163. package/dist/commands/help.js +124 -0
  164. package/dist/commands/help.js.map +1 -0
  165. package/dist/commands/helpers.d.ts.map +1 -0
  166. package/dist/commands/helpers.js +167 -0
  167. package/dist/commands/helpers.js.map +1 -0
  168. package/dist/commands/history.d.ts.map +1 -0
  169. package/dist/commands/history.js +27 -0
  170. package/dist/commands/history.js.map +1 -0
  171. package/dist/commands/hostname.d.ts.map +1 -0
  172. package/dist/commands/hostname.js +13 -0
  173. package/dist/commands/hostname.js.map +1 -0
  174. package/dist/commands/htop.d.ts.map +1 -0
  175. package/dist/commands/htop.js +18 -0
  176. package/dist/commands/htop.js.map +1 -0
  177. package/dist/commands/id.d.ts.map +1 -0
  178. package/dist/commands/id.js +18 -0
  179. package/dist/commands/id.js.map +1 -0
  180. package/dist/commands/index.d.ts.map +1 -0
  181. package/dist/commands/index.js +3 -0
  182. package/dist/commands/index.js.map +1 -0
  183. package/dist/commands/kill.d.ts.map +1 -0
  184. package/dist/commands/kill.js +19 -0
  185. package/dist/commands/kill.js.map +1 -0
  186. package/dist/commands/ln.d.ts.map +1 -0
  187. package/dist/commands/ln.js +67 -0
  188. package/dist/commands/ln.js.map +1 -0
  189. package/dist/commands/ls.d.ts.map +1 -0
  190. package/dist/commands/ls.js +201 -0
  191. package/dist/commands/ls.js.map +1 -0
  192. package/dist/commands/lsb-release.d.ts.map +1 -0
  193. package/dist/commands/lsb-release.js +62 -0
  194. package/dist/commands/lsb-release.js.map +1 -0
  195. package/dist/commands/man.d.ts.map +1 -0
  196. package/dist/commands/man.js +50 -0
  197. package/dist/commands/man.js.map +1 -0
  198. package/dist/commands/mkdir.d.ts.map +1 -0
  199. package/dist/commands/mkdir.js +29 -0
  200. package/dist/commands/mkdir.js.map +1 -0
  201. package/dist/commands/mv.d.ts.map +1 -0
  202. package/dist/commands/mv.js +43 -0
  203. package/dist/commands/mv.js.map +1 -0
  204. package/dist/commands/nano.d.ts.map +1 -0
  205. package/dist/commands/nano.js +35 -0
  206. package/dist/commands/nano.js.map +1 -0
  207. package/dist/commands/neofetch.d.ts.map +1 -0
  208. package/dist/commands/neofetch.js +49 -0
  209. package/dist/commands/neofetch.js.map +1 -0
  210. package/dist/commands/node.d.ts.map +1 -0
  211. package/dist/commands/node.js +317 -0
  212. package/dist/commands/node.js.map +1 -0
  213. package/dist/commands/npm.d.ts.map +1 -0
  214. package/dist/commands/npm.js +110 -0
  215. package/dist/commands/npm.js.map +1 -0
  216. package/dist/commands/passwd.d.ts.map +1 -0
  217. package/dist/commands/passwd.js +45 -0
  218. package/dist/commands/passwd.js.map +1 -0
  219. package/dist/commands/ping.d.ts.map +1 -0
  220. package/dist/commands/ping.js +29 -0
  221. package/dist/commands/ping.js.map +1 -0
  222. package/dist/commands/printf.d.ts.map +1 -0
  223. package/dist/commands/printf.js +145 -0
  224. package/dist/commands/printf.js.map +1 -0
  225. package/dist/commands/ps.d.ts.map +1 -0
  226. package/dist/commands/ps.js +47 -0
  227. package/dist/commands/ps.js.map +1 -0
  228. package/dist/commands/pwd.d.ts.map +1 -0
  229. package/dist/commands/pwd.js +8 -0
  230. package/dist/commands/pwd.js.map +1 -0
  231. package/dist/commands/python.d.ts.map +1 -0
  232. package/dist/commands/python.js +2059 -0
  233. package/dist/commands/python.js.map +1 -0
  234. package/dist/commands/read.d.ts.map +1 -0
  235. package/dist/commands/read.js +40 -0
  236. package/dist/commands/read.js.map +1 -0
  237. package/dist/commands/registry.d.ts.map +1 -0
  238. package/dist/commands/registry.js +235 -0
  239. package/dist/commands/registry.js.map +1 -0
  240. package/dist/commands/rm.d.ts.map +1 -0
  241. package/dist/commands/rm.js +37 -0
  242. package/dist/commands/rm.js.map +1 -0
  243. package/dist/commands/runtime.d.ts.map +1 -0
  244. package/dist/commands/runtime.js +286 -0
  245. package/dist/commands/runtime.js.map +1 -0
  246. package/dist/commands/sed.d.ts.map +1 -0
  247. package/dist/commands/sed.js +61 -0
  248. package/dist/commands/sed.js.map +1 -0
  249. package/dist/commands/seq.d.ts.map +1 -0
  250. package/dist/commands/seq.js +51 -0
  251. package/dist/commands/seq.js.map +1 -0
  252. package/dist/commands/set.d.ts.map +1 -0
  253. package/dist/commands/set.js +27 -0
  254. package/dist/commands/set.js.map +1 -0
  255. package/dist/commands/sh.d.ts.map +1 -0
  256. package/dist/commands/sh.js +432 -0
  257. package/dist/commands/sh.js.map +1 -0
  258. package/dist/commands/shift.d.ts.map +1 -0
  259. package/dist/commands/shift.js +63 -0
  260. package/dist/commands/shift.js.map +1 -0
  261. package/dist/commands/sleep.d.ts.map +1 -0
  262. package/dist/commands/sleep.js +19 -0
  263. package/dist/commands/sleep.js.map +1 -0
  264. package/dist/commands/sort.d.ts.map +1 -0
  265. package/dist/commands/sort.js +45 -0
  266. package/dist/commands/sort.js.map +1 -0
  267. package/dist/commands/source.d.ts.map +1 -0
  268. package/dist/commands/source.js +40 -0
  269. package/dist/commands/source.js.map +1 -0
  270. package/dist/commands/stat.d.ts.map +1 -0
  271. package/dist/commands/stat.js +57 -0
  272. package/dist/commands/stat.js.map +1 -0
  273. package/dist/commands/su.d.ts.map +1 -0
  274. package/dist/commands/su.js +58 -0
  275. package/dist/commands/su.js.map +1 -0
  276. package/dist/commands/sudo.d.ts.map +1 -0
  277. package/dist/commands/sudo.js +55 -0
  278. package/dist/commands/sudo.js.map +1 -0
  279. package/dist/commands/tail.d.ts.map +1 -0
  280. package/dist/commands/tail.js +48 -0
  281. package/dist/commands/tail.js.map +1 -0
  282. package/dist/commands/tar.d.ts.map +1 -0
  283. package/dist/commands/tar.js +103 -0
  284. package/dist/commands/tar.js.map +1 -0
  285. package/dist/commands/tee.d.ts.map +1 -0
  286. package/dist/commands/tee.js +37 -0
  287. package/dist/commands/tee.js.map +1 -0
  288. package/dist/commands/test.d.ts.map +1 -0
  289. package/dist/commands/test.js +115 -0
  290. package/dist/commands/test.js.map +1 -0
  291. package/dist/commands/touch.d.ts.map +1 -0
  292. package/dist/commands/touch.js +26 -0
  293. package/dist/commands/touch.js.map +1 -0
  294. package/dist/commands/tr.d.ts.map +1 -0
  295. package/dist/commands/tr.js +62 -0
  296. package/dist/commands/tr.js.map +1 -0
  297. package/dist/commands/tree.d.ts.map +1 -0
  298. package/dist/commands/tree.js +19 -0
  299. package/dist/commands/tree.js.map +1 -0
  300. package/dist/commands/true.d.ts.map +1 -0
  301. package/dist/commands/true.js +25 -0
  302. package/dist/commands/true.js.map +1 -0
  303. package/dist/commands/type.d.ts.map +1 -0
  304. package/dist/commands/type.js +40 -0
  305. package/dist/commands/type.js.map +1 -0
  306. package/dist/commands/uname.d.ts.map +1 -0
  307. package/dist/commands/uname.js +30 -0
  308. package/dist/commands/uname.js.map +1 -0
  309. package/dist/commands/uniq.d.ts.map +1 -0
  310. package/dist/commands/uniq.js +39 -0
  311. package/dist/commands/uniq.js.map +1 -0
  312. package/dist/commands/unset.d.ts.map +1 -0
  313. package/dist/commands/unset.js +17 -0
  314. package/dist/commands/unset.js.map +1 -0
  315. package/dist/commands/uptime.d.ts.map +1 -0
  316. package/dist/commands/uptime.js +49 -0
  317. package/dist/commands/uptime.js.map +1 -0
  318. package/dist/commands/wc.d.ts.map +1 -0
  319. package/dist/commands/wc.js +56 -0
  320. package/dist/commands/wc.js.map +1 -0
  321. package/dist/commands/wget.d.ts.map +1 -0
  322. package/dist/commands/wget.js +127 -0
  323. package/dist/commands/wget.js.map +1 -0
  324. package/dist/commands/which.d.ts.map +1 -0
  325. package/dist/commands/which.js +33 -0
  326. package/dist/commands/which.js.map +1 -0
  327. package/dist/commands/who.d.ts.map +1 -0
  328. package/dist/commands/who.js +23 -0
  329. package/dist/commands/who.js.map +1 -0
  330. package/dist/commands/whoami.d.ts.map +1 -0
  331. package/dist/commands/whoami.js +13 -0
  332. package/dist/commands/whoami.js.map +1 -0
  333. package/dist/commands/xargs.d.ts.map +1 -0
  334. package/dist/commands/xargs.js +22 -0
  335. package/dist/commands/xargs.js.map +1 -0
  336. package/dist/index.d.ts.map +1 -0
  337. package/dist/index.js +10 -0
  338. package/dist/index.js.map +1 -0
  339. package/dist/modules/linuxRootfs.d.ts.map +1 -0
  340. package/dist/modules/linuxRootfs.js +620 -0
  341. package/dist/modules/linuxRootfs.js.map +1 -0
  342. package/dist/modules/neofetch.d.ts.map +1 -0
  343. package/dist/modules/neofetch.js +285 -0
  344. package/dist/modules/neofetch.js.map +1 -0
  345. package/dist/modules/shellInteractive.d.ts.map +1 -0
  346. package/dist/modules/shellInteractive.js +27 -0
  347. package/dist/modules/shellInteractive.js.map +1 -0
  348. package/dist/modules/shellRuntime.d.ts.map +1 -0
  349. package/dist/modules/shellRuntime.js +53 -0
  350. package/dist/modules/shellRuntime.js.map +1 -0
  351. package/dist/self-standalone.d.ts.map +1 -0
  352. package/dist/self-standalone.js +420 -0
  353. package/dist/self-standalone.js.map +1 -0
  354. package/dist/standalone-wo-sftp.d.ts.map +1 -0
  355. package/dist/standalone-wo-sftp.js +31 -0
  356. package/dist/standalone-wo-sftp.js.map +1 -0
  357. package/dist/standalone.d.ts.map +1 -0
  358. package/dist/standalone.js +40 -0
  359. package/dist/standalone.js.map +1 -0
  360. package/dist/types/commands.d.ts.map +1 -0
  361. package/dist/types/commands.js +1 -0
  362. package/dist/types/commands.js.map +1 -0
  363. package/dist/types/pipeline.d.ts.map +1 -0
  364. package/dist/types/pipeline.js +1 -0
  365. package/dist/types/pipeline.js.map +1 -0
  366. package/dist/types/streams.d.ts.map +1 -0
  367. package/dist/types/streams.js +1 -0
  368. package/dist/types/streams.js.map +1 -0
  369. package/dist/types/vfs.d.ts.map +1 -0
  370. package/dist/types/vfs.js +1 -0
  371. package/dist/types/vfs.js.map +1 -0
  372. package/dist/utils/expand.d.ts.map +1 -0
  373. package/dist/utils/expand.js +477 -0
  374. package/dist/utils/expand.js.map +1 -0
  375. package/dist/utils/perfLogger.d.ts.map +1 -0
  376. package/dist/utils/perfLogger.js +50 -0
  377. package/dist/utils/perfLogger.js.map +1 -0
  378. package/dist/utils/tokenize.d.ts.map +1 -0
  379. package/dist/utils/tokenize.js +115 -0
  380. package/dist/utils/tokenize.js.map +1 -0
  381. package/dist/utils/vfsDiff.d.ts.map +1 -0
  382. package/dist/utils/vfsDiff.js +178 -0
  383. package/dist/utils/vfsDiff.js.map +1 -0
  384. package/dist/web-api.d.ts.map +1 -0
  385. package/dist/web-api.js +47 -0
  386. package/dist/web-api.js.map +1 -0
  387. package/dist/web-full.d.ts.map +1 -0
  388. package/dist/web-full.js +9 -0
  389. package/dist/web-full.js.map +1 -0
  390. package/dist/web.d.ts.map +1 -0
  391. package/dist/web.js +774 -0
  392. package/dist/web.js.map +1 -0
  393. package/docs/.nojekyll +1 -0
  394. package/docs/assets/hierarchy.js +1 -0
  395. package/docs/assets/highlight.css +162 -0
  396. package/docs/assets/icons.js +18 -0
  397. package/docs/assets/icons.svg +1 -0
  398. package/docs/assets/main.js +60 -0
  399. package/docs/assets/navigation.js +1 -0
  400. package/docs/assets/search.js +1 -0
  401. package/docs/assets/style.css +1633 -0
  402. package/docs/classes/HoneyPot.html +31 -0
  403. package/docs/classes/SshClient.html +66 -0
  404. package/docs/classes/VirtualFileSystem.html +262 -0
  405. package/docs/classes/VirtualPackageManager.html +63 -0
  406. package/docs/classes/VirtualSftpServer.html +169 -0
  407. package/docs/classes/VirtualShell.html +265 -0
  408. package/docs/classes/VirtualSshServer.html +177 -0
  409. package/docs/classes/VirtualUserManager.html +276 -0
  410. package/docs/functions/assertDiff.html +6 -0
  411. package/docs/functions/diffSnapshots.html +7 -0
  412. package/docs/functions/formatDiff.html +6 -0
  413. package/docs/functions/getArg.html +13 -0
  414. package/docs/functions/getFlag.html +15 -0
  415. package/docs/functions/ifFlag.html +11 -0
  416. package/docs/hierarchy.html +1 -0
  417. package/docs/index.html +1842 -0
  418. package/docs/interfaces/AuditLogEntry.html +6 -0
  419. package/docs/interfaces/CommandContext.html +22 -0
  420. package/docs/interfaces/CommandResult.html +26 -0
  421. package/docs/interfaces/ExecStream.html +11 -0
  422. package/docs/interfaces/HoneyPotStats.html +14 -0
  423. package/docs/interfaces/InstalledPackage.html +20 -0
  424. package/docs/interfaces/NanoEditorSession.html +8 -0
  425. package/docs/interfaces/PackageDefinition.html +30 -0
  426. package/docs/interfaces/PackageFile.html +8 -0
  427. package/docs/interfaces/RemoveOptions.html +4 -0
  428. package/docs/interfaces/ShellEnv.html +6 -0
  429. package/docs/interfaces/ShellModule.html +14 -0
  430. package/docs/interfaces/ShellProperties.html +14 -0
  431. package/docs/interfaces/ShellStream.html +11 -0
  432. package/docs/interfaces/SudoChallenge.html +24 -0
  433. package/docs/interfaces/VfsBaseNode.html +12 -0
  434. package/docs/interfaces/VfsDiff.html +10 -0
  435. package/docs/interfaces/VfsDiffEntry.html +6 -0
  436. package/docs/interfaces/VfsDiffModified.html +10 -0
  437. package/docs/interfaces/VfsDirectoryNode.html +15 -0
  438. package/docs/interfaces/VfsFileNode.html +17 -0
  439. package/docs/interfaces/VfsOptions.html +12 -0
  440. package/docs/interfaces/VfsSnapshot.html +3 -0
  441. package/docs/interfaces/VfsSnapshotBaseNode.html +8 -0
  442. package/docs/interfaces/VfsSnapshotDirectoryNode.html +10 -0
  443. package/docs/interfaces/VfsSnapshotFileNode.html +12 -0
  444. package/docs/interfaces/WriteFileOptions.html +6 -0
  445. package/docs/media/LICENSE +21 -0
  446. package/docs/modules.html +1 -0
  447. package/docs/types/CommandMode.html +2 -0
  448. package/docs/types/CommandOutcome.html +2 -0
  449. package/docs/types/VfsNodeStats.html +2 -0
  450. package/docs/types/VfsNodeType.html +2 -0
  451. package/docs/types/VfsPersistenceMode.html +5 -0
  452. package/docs/types/VfsSnapshotNode.html +2 -0
  453. package/examples/web.min.js +5 -5
  454. package/package.json +6 -4
  455. package/src/commands/man.ts +1 -1
  456. package/src/self-standalone.ts +1 -1
  457. package/src/standalone.ts +8 -3
  458. package/tsconfig.json +7 -2
  459. package/src/Honeypot/index.d.ts.map +0 -1
  460. package/src/Honeypot/index.js +0 -298
  461. package/src/SSHClient/index.d.ts.map +0 -1
  462. package/src/SSHClient/index.js +0 -237
  463. package/src/SSHMimic/exec.d.ts.map +0 -1
  464. package/src/SSHMimic/exec.js +0 -27
  465. package/src/SSHMimic/executor.d.ts.map +0 -1
  466. package/src/SSHMimic/executor.js +0 -160
  467. package/src/SSHMimic/hostKey.d.ts.map +0 -1
  468. package/src/SSHMimic/hostKey.js +0 -17
  469. package/src/SSHMimic/index.d.ts.map +0 -1
  470. package/src/SSHMimic/index.js +0 -249
  471. package/src/SSHMimic/loginBanner.d.ts.map +0 -1
  472. package/src/SSHMimic/loginBanner.js +0 -22
  473. package/src/SSHMimic/loginFormat.d.ts.map +0 -1
  474. package/src/SSHMimic/loginFormat.js +0 -10
  475. package/src/SSHMimic/prompt.d.ts.map +0 -1
  476. package/src/SSHMimic/prompt.js +0 -9
  477. package/src/SSHMimic/sftp.d.ts.map +0 -1
  478. package/src/SSHMimic/sftp.js +0 -619
  479. package/src/VirtualFileSystem/binaryPack.d.ts.map +0 -1
  480. package/src/VirtualFileSystem/binaryPack.js +0 -216
  481. package/src/VirtualFileSystem/index.d.ts.map +0 -1
  482. package/src/VirtualFileSystem/index.js +0 -689
  483. package/src/VirtualFileSystem/internalTypes.d.ts.map +0 -1
  484. package/src/VirtualFileSystem/internalTypes.js +0 -0
  485. package/src/VirtualFileSystem/path.d.ts.map +0 -1
  486. package/src/VirtualFileSystem/path.js +0 -49
  487. package/src/VirtualPackageManager/index.d.ts.map +0 -1
  488. package/src/VirtualPackageManager/index.js +0 -853
  489. package/src/VirtualShell/index.d.ts.map +0 -1
  490. package/src/VirtualShell/index.js +0 -284
  491. package/src/VirtualShell/shell.d.ts.map +0 -1
  492. package/src/VirtualShell/shell.js +0 -502
  493. package/src/VirtualShell/shellParser.d.ts.map +0 -1
  494. package/src/VirtualShell/shellParser.js +0 -265
  495. package/src/VirtualUserManager/index.d.ts.map +0 -1
  496. package/src/VirtualUserManager/index.js +0 -607
  497. package/src/commands/adduser.d.ts.map +0 -1
  498. package/src/commands/adduser.js +0 -89
  499. package/src/commands/alias.d.ts.map +0 -1
  500. package/src/commands/alias.js +0 -68
  501. package/src/commands/apt.d.ts.map +0 -1
  502. package/src/commands/apt.js +0 -210
  503. package/src/commands/awk.d.ts.map +0 -1
  504. package/src/commands/awk.js +0 -169
  505. package/src/commands/base64.d.ts.map +0 -1
  506. package/src/commands/base64.js +0 -28
  507. package/src/commands/cat.d.ts.map +0 -1
  508. package/src/commands/cat.js +0 -44
  509. package/src/commands/cd.d.ts.map +0 -1
  510. package/src/commands/cd.js +0 -21
  511. package/src/commands/chmod.d.ts.map +0 -1
  512. package/src/commands/chmod.js +0 -87
  513. package/src/commands/clear.d.ts.map +0 -1
  514. package/src/commands/clear.js +0 -13
  515. package/src/commands/command-helpers.d.ts.map +0 -1
  516. package/src/commands/command-helpers.js +0 -221
  517. package/src/commands/cp.d.ts.map +0 -1
  518. package/src/commands/cp.js +0 -75
  519. package/src/commands/curl.d.ts.map +0 -1
  520. package/src/commands/curl.js +0 -127
  521. package/src/commands/cut.d.ts.map +0 -1
  522. package/src/commands/cut.js +0 -34
  523. package/src/commands/date.d.ts.map +0 -1
  524. package/src/commands/date.js +0 -28
  525. package/src/commands/declare.d.ts.map +0 -1
  526. package/src/commands/declare.js +0 -44
  527. package/src/commands/deluser.d.ts.map +0 -1
  528. package/src/commands/deluser.js +0 -83
  529. package/src/commands/df.d.ts.map +0 -1
  530. package/src/commands/df.js +0 -21
  531. package/src/commands/diff.d.ts.map +0 -1
  532. package/src/commands/diff.js +0 -45
  533. package/src/commands/dpkg.d.ts.map +0 -1
  534. package/src/commands/dpkg.js +0 -161
  535. package/src/commands/du.d.ts.map +0 -1
  536. package/src/commands/du.js +0 -50
  537. package/src/commands/echo.d.ts.map +0 -1
  538. package/src/commands/echo.js +0 -45
  539. package/src/commands/env.d.ts.map +0 -1
  540. package/src/commands/env.js +0 -20
  541. package/src/commands/exit.d.ts.map +0 -1
  542. package/src/commands/exit.js +0 -16
  543. package/src/commands/export.d.ts.map +0 -1
  544. package/src/commands/export.js +0 -33
  545. package/src/commands/find.d.ts.map +0 -1
  546. package/src/commands/find.js +0 -55
  547. package/src/commands/free.d.ts.map +0 -1
  548. package/src/commands/free.js +0 -43
  549. package/src/commands/grep.d.ts.map +0 -1
  550. package/src/commands/grep.js +0 -120
  551. package/src/commands/groups.d.ts.map +0 -1
  552. package/src/commands/groups.js +0 -17
  553. package/src/commands/gzip.d.ts.map +0 -1
  554. package/src/commands/gzip.js +0 -82
  555. package/src/commands/head.d.ts.map +0 -1
  556. package/src/commands/head.js +0 -46
  557. package/src/commands/help.d.ts.map +0 -1
  558. package/src/commands/help.js +0 -123
  559. package/src/commands/helpers.d.ts.map +0 -1
  560. package/src/commands/helpers.js +0 -166
  561. package/src/commands/history.d.ts.map +0 -1
  562. package/src/commands/history.js +0 -26
  563. package/src/commands/hostname.d.ts.map +0 -1
  564. package/src/commands/hostname.js +0 -12
  565. package/src/commands/htop.d.ts.map +0 -1
  566. package/src/commands/htop.js +0 -17
  567. package/src/commands/id.d.ts.map +0 -1
  568. package/src/commands/id.js +0 -17
  569. package/src/commands/index.d.ts.map +0 -1
  570. package/src/commands/index.js +0 -2
  571. package/src/commands/kill.d.ts.map +0 -1
  572. package/src/commands/kill.js +0 -18
  573. package/src/commands/ln.d.ts.map +0 -1
  574. package/src/commands/ln.js +0 -66
  575. package/src/commands/ls.d.ts.map +0 -1
  576. package/src/commands/ls.js +0 -200
  577. package/src/commands/lsb-release.d.ts.map +0 -1
  578. package/src/commands/lsb-release.js +0 -61
  579. package/src/commands/man.d.ts.map +0 -1
  580. package/src/commands/man.js +0 -49
  581. package/src/commands/mkdir.d.ts.map +0 -1
  582. package/src/commands/mkdir.js +0 -28
  583. package/src/commands/mv.d.ts.map +0 -1
  584. package/src/commands/mv.js +0 -42
  585. package/src/commands/nano.d.ts.map +0 -1
  586. package/src/commands/nano.js +0 -34
  587. package/src/commands/neofetch.d.ts.map +0 -1
  588. package/src/commands/neofetch.js +0 -48
  589. package/src/commands/node.d.ts.map +0 -1
  590. package/src/commands/node.js +0 -316
  591. package/src/commands/npm.d.ts.map +0 -1
  592. package/src/commands/npm.js +0 -109
  593. package/src/commands/passwd.d.ts.map +0 -1
  594. package/src/commands/passwd.js +0 -44
  595. package/src/commands/ping.d.ts.map +0 -1
  596. package/src/commands/ping.js +0 -28
  597. package/src/commands/printf.d.ts.map +0 -1
  598. package/src/commands/printf.js +0 -144
  599. package/src/commands/ps.d.ts.map +0 -1
  600. package/src/commands/ps.js +0 -46
  601. package/src/commands/pwd.d.ts.map +0 -1
  602. package/src/commands/pwd.js +0 -7
  603. package/src/commands/python.d.ts.map +0 -1
  604. package/src/commands/python.js +0 -2058
  605. package/src/commands/read.d.ts.map +0 -1
  606. package/src/commands/read.js +0 -39
  607. package/src/commands/registry.d.ts.map +0 -1
  608. package/src/commands/registry.js +0 -234
  609. package/src/commands/rm.d.ts.map +0 -1
  610. package/src/commands/rm.js +0 -36
  611. package/src/commands/runtime.d.ts.map +0 -1
  612. package/src/commands/runtime.js +0 -285
  613. package/src/commands/sed.d.ts.map +0 -1
  614. package/src/commands/sed.js +0 -60
  615. package/src/commands/seq.d.ts.map +0 -1
  616. package/src/commands/seq.js +0 -50
  617. package/src/commands/set.d.ts.map +0 -1
  618. package/src/commands/set.js +0 -26
  619. package/src/commands/sh.d.ts.map +0 -1
  620. package/src/commands/sh.js +0 -431
  621. package/src/commands/shift.d.ts.map +0 -1
  622. package/src/commands/shift.js +0 -62
  623. package/src/commands/sleep.d.ts.map +0 -1
  624. package/src/commands/sleep.js +0 -18
  625. package/src/commands/sort.d.ts.map +0 -1
  626. package/src/commands/sort.js +0 -44
  627. package/src/commands/source.d.ts.map +0 -1
  628. package/src/commands/source.js +0 -39
  629. package/src/commands/stat.d.ts.map +0 -1
  630. package/src/commands/stat.js +0 -56
  631. package/src/commands/su.d.ts.map +0 -1
  632. package/src/commands/su.js +0 -57
  633. package/src/commands/sudo.d.ts.map +0 -1
  634. package/src/commands/sudo.js +0 -54
  635. package/src/commands/tail.d.ts.map +0 -1
  636. package/src/commands/tail.js +0 -47
  637. package/src/commands/tar.d.ts.map +0 -1
  638. package/src/commands/tar.js +0 -102
  639. package/src/commands/tee.d.ts.map +0 -1
  640. package/src/commands/tee.js +0 -36
  641. package/src/commands/test.d.ts.map +0 -1
  642. package/src/commands/test.js +0 -114
  643. package/src/commands/touch.d.ts.map +0 -1
  644. package/src/commands/touch.js +0 -25
  645. package/src/commands/tr.d.ts.map +0 -1
  646. package/src/commands/tr.js +0 -61
  647. package/src/commands/tree.d.ts.map +0 -1
  648. package/src/commands/tree.js +0 -18
  649. package/src/commands/true.d.ts.map +0 -1
  650. package/src/commands/true.js +0 -24
  651. package/src/commands/type.d.ts.map +0 -1
  652. package/src/commands/type.js +0 -39
  653. package/src/commands/uname.d.ts.map +0 -1
  654. package/src/commands/uname.js +0 -29
  655. package/src/commands/uniq.d.ts.map +0 -1
  656. package/src/commands/uniq.js +0 -38
  657. package/src/commands/unset.d.ts.map +0 -1
  658. package/src/commands/unset.js +0 -16
  659. package/src/commands/uptime.d.ts.map +0 -1
  660. package/src/commands/uptime.js +0 -48
  661. package/src/commands/wc.d.ts.map +0 -1
  662. package/src/commands/wc.js +0 -55
  663. package/src/commands/wget.d.ts.map +0 -1
  664. package/src/commands/wget.js +0 -126
  665. package/src/commands/which.d.ts.map +0 -1
  666. package/src/commands/which.js +0 -32
  667. package/src/commands/who.d.ts.map +0 -1
  668. package/src/commands/who.js +0 -22
  669. package/src/commands/whoami.d.ts.map +0 -1
  670. package/src/commands/whoami.js +0 -12
  671. package/src/commands/xargs.d.ts.map +0 -1
  672. package/src/commands/xargs.js +0 -21
  673. package/src/index.d.ts.map +0 -1
  674. package/src/index.js +0 -9
  675. package/src/modules/linuxRootfs.d.ts.map +0 -1
  676. package/src/modules/linuxRootfs.js +0 -619
  677. package/src/modules/neofetch.d.ts.map +0 -1
  678. package/src/modules/neofetch.js +0 -284
  679. package/src/modules/shellInteractive.d.ts.map +0 -1
  680. package/src/modules/shellInteractive.js +0 -26
  681. package/src/modules/shellRuntime.d.ts.map +0 -1
  682. package/src/modules/shellRuntime.js +0 -52
  683. package/src/self-standalone.d.ts.map +0 -1
  684. package/src/self-standalone.js +0 -418
  685. package/src/standalone-wo-sftp.d.ts.map +0 -1
  686. package/src/standalone-wo-sftp.js +0 -30
  687. package/src/standalone.d.ts.map +0 -1
  688. package/src/standalone.js +0 -35
  689. package/src/types/commands.d.ts.map +0 -1
  690. package/src/types/commands.js +0 -0
  691. package/src/types/pipeline.d.ts.map +0 -1
  692. package/src/types/pipeline.js +0 -0
  693. package/src/types/streams.d.ts.map +0 -1
  694. package/src/types/streams.js +0 -0
  695. package/src/types/vfs.d.ts.map +0 -1
  696. package/src/types/vfs.js +0 -0
  697. package/src/utils/expand.d.ts.map +0 -1
  698. package/src/utils/expand.js +0 -476
  699. package/src/utils/perfLogger.d.ts.map +0 -1
  700. package/src/utils/perfLogger.js +0 -49
  701. package/src/utils/tokenize.d.ts.map +0 -1
  702. package/src/utils/tokenize.js +0 -114
  703. package/src/utils/vfsDiff.d.ts.map +0 -1
  704. package/src/utils/vfsDiff.js +0 -177
  705. package/src/web-api.d.ts.map +0 -1
  706. package/src/web-api.js +0 -46
  707. package/src/web-full.d.ts.map +0 -1
  708. package/src/web-full.js +0 -8
  709. package/src/web.d.ts.map +0 -1
  710. package/src/web.js +0 -773
  711. package/tests/command-helpers.test.d.ts +0 -2
  712. package/tests/command-helpers.test.d.ts.map +0 -1
  713. package/tests/command-helpers.test.js +0 -92
  714. package/tests/commands-admin-net.test.d.ts +0 -2
  715. package/tests/commands-admin-net.test.d.ts.map +0 -1
  716. package/tests/commands-admin-net.test.js +0 -353
  717. package/tests/commands-advanced.test.d.ts +0 -2
  718. package/tests/commands-advanced.test.d.ts.map +0 -1
  719. package/tests/commands-advanced.test.js +0 -378
  720. package/tests/commands-core.test.d.ts +0 -2
  721. package/tests/commands-core.test.d.ts.map +0 -1
  722. package/tests/commands-core.test.js +0 -477
  723. package/tests/commands-missing.test.d.ts +0 -2
  724. package/tests/commands-missing.test.d.ts.map +0 -1
  725. package/tests/commands-missing.test.js +0 -470
  726. package/tests/commands-specific-units.test.d.ts +0 -2
  727. package/tests/commands-specific-units.test.d.ts.map +0 -1
  728. package/tests/commands-specific-units.test.js +0 -264
  729. package/tests/commands-text-sys.test.d.ts +0 -2
  730. package/tests/commands-text-sys.test.d.ts.map +0 -1
  731. package/tests/commands-text-sys.test.js +0 -366
  732. package/tests/expand.test.d.ts +0 -2
  733. package/tests/expand.test.d.ts.map +0 -1
  734. package/tests/expand.test.js +0 -138
  735. package/tests/helpers.test.d.ts +0 -2
  736. package/tests/helpers.test.d.ts.map +0 -1
  737. package/tests/helpers.test.js +0 -52
  738. package/tests/new-features.test.d.ts +0 -2
  739. package/tests/new-features.test.d.ts.map +0 -1
  740. package/tests/new-features.test.js +0 -850
  741. package/tests/parser-executor.test.d.ts +0 -2
  742. package/tests/parser-executor.test.d.ts.map +0 -1
  743. package/tests/parser-executor.test.js +0 -25
  744. package/tests/sftp.test.d.ts +0 -2
  745. package/tests/sftp.test.d.ts.map +0 -1
  746. package/tests/sftp.test.js +0 -246
  747. package/tests/ssh-exec.test.d.ts +0 -2
  748. package/tests/ssh-exec.test.d.ts.map +0 -1
  749. package/tests/ssh-exec.test.js +0 -39
  750. package/tests/test-helper.d.ts +0 -56
  751. package/tests/test-helper.d.ts.map +0 -1
  752. package/tests/test-helper.js +0 -71
  753. package/tests/users.test.d.ts +0 -2
  754. package/tests/users.test.d.ts.map +0 -1
  755. package/tests/users.test.js +0 -71
  756. package/tests/web.test.d.ts +0 -2
  757. package/tests/web.test.d.ts.map +0 -1
  758. package/tests/web.test.js +0 -149
  759. /package/{src → dist}/Honeypot/index.d.ts +0 -0
  760. /package/{src → dist}/SSHClient/index.d.ts +0 -0
  761. /package/{src → dist}/SSHMimic/exec.d.ts +0 -0
  762. /package/{src → dist}/SSHMimic/executor.d.ts +0 -0
  763. /package/{src → dist}/SSHMimic/hostKey.d.ts +0 -0
  764. /package/{src → dist}/SSHMimic/index.d.ts +0 -0
  765. /package/{src → dist}/SSHMimic/loginBanner.d.ts +0 -0
  766. /package/{src → dist}/SSHMimic/loginFormat.d.ts +0 -0
  767. /package/{src → dist}/SSHMimic/prompt.d.ts +0 -0
  768. /package/{src → dist}/SSHMimic/sftp.d.ts +0 -0
  769. /package/{src → dist}/VirtualFileSystem/binaryPack.d.ts +0 -0
  770. /package/{src → dist}/VirtualFileSystem/index.d.ts +0 -0
  771. /package/{src → dist}/VirtualFileSystem/internalTypes.d.ts +0 -0
  772. /package/{src → dist}/VirtualFileSystem/path.d.ts +0 -0
  773. /package/{src → dist}/VirtualPackageManager/index.d.ts +0 -0
  774. /package/{src → dist}/VirtualShell/index.d.ts +0 -0
  775. /package/{src → dist}/VirtualShell/shell.d.ts +0 -0
  776. /package/{src → dist}/VirtualShell/shellParser.d.ts +0 -0
  777. /package/{src → dist}/VirtualUserManager/index.d.ts +0 -0
  778. /package/{src → dist}/commands/adduser.d.ts +0 -0
  779. /package/{src → dist}/commands/alias.d.ts +0 -0
  780. /package/{src → dist}/commands/apt.d.ts +0 -0
  781. /package/{src → dist}/commands/awk.d.ts +0 -0
  782. /package/{src → dist}/commands/base64.d.ts +0 -0
  783. /package/{src → dist}/commands/cat.d.ts +0 -0
  784. /package/{src → dist}/commands/cd.d.ts +0 -0
  785. /package/{src → dist}/commands/chmod.d.ts +0 -0
  786. /package/{src → dist}/commands/clear.d.ts +0 -0
  787. /package/{src → dist}/commands/command-helpers.d.ts +0 -0
  788. /package/{src → dist}/commands/cp.d.ts +0 -0
  789. /package/{src → dist}/commands/curl.d.ts +0 -0
  790. /package/{src → dist}/commands/cut.d.ts +0 -0
  791. /package/{src → dist}/commands/date.d.ts +0 -0
  792. /package/{src → dist}/commands/declare.d.ts +0 -0
  793. /package/{src → dist}/commands/deluser.d.ts +0 -0
  794. /package/{src → dist}/commands/df.d.ts +0 -0
  795. /package/{src → dist}/commands/diff.d.ts +0 -0
  796. /package/{src → dist}/commands/dpkg.d.ts +0 -0
  797. /package/{src → dist}/commands/du.d.ts +0 -0
  798. /package/{src → dist}/commands/echo.d.ts +0 -0
  799. /package/{src → dist}/commands/env.d.ts +0 -0
  800. /package/{src → dist}/commands/exit.d.ts +0 -0
  801. /package/{src → dist}/commands/export.d.ts +0 -0
  802. /package/{src → dist}/commands/find.d.ts +0 -0
  803. /package/{src → dist}/commands/free.d.ts +0 -0
  804. /package/{src → dist}/commands/grep.d.ts +0 -0
  805. /package/{src → dist}/commands/groups.d.ts +0 -0
  806. /package/{src → dist}/commands/gzip.d.ts +0 -0
  807. /package/{src → dist}/commands/head.d.ts +0 -0
  808. /package/{src → dist}/commands/help.d.ts +0 -0
  809. /package/{src → dist}/commands/helpers.d.ts +0 -0
  810. /package/{src → dist}/commands/history.d.ts +0 -0
  811. /package/{src → dist}/commands/hostname.d.ts +0 -0
  812. /package/{src → dist}/commands/htop.d.ts +0 -0
  813. /package/{src → dist}/commands/id.d.ts +0 -0
  814. /package/{src → dist}/commands/index.d.ts +0 -0
  815. /package/{src → dist}/commands/kill.d.ts +0 -0
  816. /package/{src → dist}/commands/ln.d.ts +0 -0
  817. /package/{src → dist}/commands/ls.d.ts +0 -0
  818. /package/{src → dist}/commands/lsb-release.d.ts +0 -0
  819. /package/{src → dist}/commands/man.d.ts +0 -0
  820. /package/{src → dist}/commands/mkdir.d.ts +0 -0
  821. /package/{src → dist}/commands/mv.d.ts +0 -0
  822. /package/{src → dist}/commands/nano.d.ts +0 -0
  823. /package/{src → dist}/commands/neofetch.d.ts +0 -0
  824. /package/{src → dist}/commands/node.d.ts +0 -0
  825. /package/{src → dist}/commands/npm.d.ts +0 -0
  826. /package/{src → dist}/commands/passwd.d.ts +0 -0
  827. /package/{src → dist}/commands/ping.d.ts +0 -0
  828. /package/{src → dist}/commands/printf.d.ts +0 -0
  829. /package/{src → dist}/commands/ps.d.ts +0 -0
  830. /package/{src → dist}/commands/pwd.d.ts +0 -0
  831. /package/{src → dist}/commands/python.d.ts +0 -0
  832. /package/{src → dist}/commands/read.d.ts +0 -0
  833. /package/{src → dist}/commands/registry.d.ts +0 -0
  834. /package/{src → dist}/commands/rm.d.ts +0 -0
  835. /package/{src → dist}/commands/runtime.d.ts +0 -0
  836. /package/{src → dist}/commands/sed.d.ts +0 -0
  837. /package/{src → dist}/commands/seq.d.ts +0 -0
  838. /package/{src → dist}/commands/set.d.ts +0 -0
  839. /package/{src → dist}/commands/sh.d.ts +0 -0
  840. /package/{src → dist}/commands/shift.d.ts +0 -0
  841. /package/{src → dist}/commands/sleep.d.ts +0 -0
  842. /package/{src → dist}/commands/sort.d.ts +0 -0
  843. /package/{src → dist}/commands/source.d.ts +0 -0
  844. /package/{src → dist}/commands/stat.d.ts +0 -0
  845. /package/{src → dist}/commands/su.d.ts +0 -0
  846. /package/{src → dist}/commands/sudo.d.ts +0 -0
  847. /package/{src → dist}/commands/tail.d.ts +0 -0
  848. /package/{src → dist}/commands/tar.d.ts +0 -0
  849. /package/{src → dist}/commands/tee.d.ts +0 -0
  850. /package/{src → dist}/commands/test.d.ts +0 -0
  851. /package/{src → dist}/commands/touch.d.ts +0 -0
  852. /package/{src → dist}/commands/tr.d.ts +0 -0
  853. /package/{src → dist}/commands/tree.d.ts +0 -0
  854. /package/{src → dist}/commands/true.d.ts +0 -0
  855. /package/{src → dist}/commands/type.d.ts +0 -0
  856. /package/{src → dist}/commands/uname.d.ts +0 -0
  857. /package/{src → dist}/commands/uniq.d.ts +0 -0
  858. /package/{src → dist}/commands/unset.d.ts +0 -0
  859. /package/{src → dist}/commands/uptime.d.ts +0 -0
  860. /package/{src → dist}/commands/wc.d.ts +0 -0
  861. /package/{src → dist}/commands/wget.d.ts +0 -0
  862. /package/{src → dist}/commands/which.d.ts +0 -0
  863. /package/{src → dist}/commands/who.d.ts +0 -0
  864. /package/{src → dist}/commands/whoami.d.ts +0 -0
  865. /package/{src → dist}/commands/xargs.d.ts +0 -0
  866. /package/{src → dist}/index.d.ts +0 -0
  867. /package/{src → dist}/modules/linuxRootfs.d.ts +0 -0
  868. /package/{src → dist}/modules/neofetch.d.ts +0 -0
  869. /package/{src → dist}/modules/shellInteractive.d.ts +0 -0
  870. /package/{src → dist}/modules/shellRuntime.d.ts +0 -0
  871. /package/{src → dist}/self-standalone.d.ts +0 -0
  872. /package/{src → dist}/standalone-wo-sftp.d.ts +0 -0
  873. /package/{src → dist}/standalone.d.ts +0 -0
  874. /package/{src → dist}/types/commands.d.ts +0 -0
  875. /package/{src → dist}/types/pipeline.d.ts +0 -0
  876. /package/{src → dist}/types/streams.d.ts +0 -0
  877. /package/{src → dist}/types/vfs.d.ts +0 -0
  878. /package/{src → dist}/utils/expand.d.ts +0 -0
  879. /package/{src → dist}/utils/perfLogger.d.ts +0 -0
  880. /package/{src → dist}/utils/tokenize.d.ts +0 -0
  881. /package/{src → dist}/utils/vfsDiff.d.ts +0 -0
  882. /package/{src → dist}/web-api.d.ts +0 -0
  883. /package/{src → dist}/web-full.d.ts +0 -0
  884. /package/{src → dist}/web.d.ts +0 -0
package/docs/interfaces/PackageDefinition.html ADDED
@@ -0,0 +1,30 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PackageDefinition | typescript-virtual-container</title><meta name="description" content="Documentation for typescript-virtual-container"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">typescript-virtual-container</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">PackageDefinition</a></li></ul><h1>Interface PackageDefinition</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Metadata and behaviour definition for a single package in the registry.</p>
2
+ <p>Used both for the built-in registry entries and for consumer-supplied custom
3
+ packages. <code>files</code> are written to the VFS on <code>install()</code>, and <code>onInstall</code> /
4
+ <code>onRemove</code> hooks allow arbitrary VFS mutations.</p>
5
+ </div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">PackageDefinition</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#architecture">architecture</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#depends">depends</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#description">description</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#files">files</a><span class="tsd-signature-symbol">?:</span> <a href="PackageFile.html" class="tsd-signature-type tsd-kind-interface">PackageFile</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#installedsizekb">installedSizeKb</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#maintainer">maintainer</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#name">name</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#oninstall">onInstall</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">vfs</span><span class="tsd-signature-symbol">:</span> <a href="../classes/VirtualFileSystem.html" class="tsd-signature-type tsd-kind-class">VirtualFileSystem</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">users</span><span class="tsd-signature-symbol">:</span> <a href="../classes/VirtualUserManager.html" class="tsd-signature-type tsd-kind-class">VirtualUserManager</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#onremove">onRemove</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">vfs</span><span class="tsd-signature-symbol">:</span> <a href="../classes/VirtualFileSystem.html" class="tsd-signature-type tsd-kind-class">VirtualFileSystem</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#section">section</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#shortdesc">shortDesc</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#version">version</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/VirtualPackageManager/index.ts#L25">src/VirtualPackageManager/index.ts:25</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#architecture" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>architecture?</span></a>
6
+ <a href="#depends" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>depends?</span></a>
7
+ <a href="#description" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>description</span></a>
8
+ <a href="#files" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>files?</span></a>
9
+ <a href="#installedsizekb" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>installed<wbr/>Size<wbr/>Kb?</span></a>
10
+ <a href="#maintainer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>maintainer?</span></a>
11
+ <a href="#name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a>
12
+ <a href="#oninstall" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Install?</span></a>
13
+ <a href="#onremove" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Remove?</span></a>
14
+ <a href="#section" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>section?</span></a>
15
+ <a href="#shortdesc" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>short<wbr/>Desc?</span></a>
16
+ <a href="#version" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>version</span></a>
17
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="architecture"><code class="tsd-tag">Optional</code><span>architecture</span><a href="#architecture" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">architecture</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>CPU architecture label (default <code>&quot;amd64&quot;</code>).</p>
18
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/VirtualPackageManager/index.ts#L31">src/VirtualPackageManager/index.ts:31</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="depends"><code class="tsd-tag">Optional</code><span>depends</span><a href="#depends" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">depends</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Other package names that must be installed first (resolved recursively).</p>
19
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/VirtualPackageManager/index.ts#L41">src/VirtualPackageManager/index.ts:41</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="description"><span>description</span><a href="#description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">description</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Full package description.</p>
20
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/VirtualPackageManager/index.ts#L35">src/VirtualPackageManager/index.ts:35</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="files"><code class="tsd-tag">Optional</code><span>files</span><a href="#files" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">files</span><span class="tsd-signature-symbol">?:</span> <a href="PackageFile.html" class="tsd-signature-type tsd-kind-interface">PackageFile</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Files to write into the VFS during installation.</p>
21
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/VirtualPackageManager/index.ts#L45">src/VirtualPackageManager/index.ts:45</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="installedsizekb"><code class="tsd-tag">Optional</code><span>installed<wbr/>Size<wbr/>Kb</span><a href="#installedsizekb" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">installedSizeKb</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Installed disk usage in kilobytes (informational).</p>
22
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/VirtualPackageManager/index.ts#L39">src/VirtualPackageManager/index.ts:39</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="maintainer"><code class="tsd-tag">Optional</code><span>maintainer</span><a href="#maintainer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">maintainer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Maintainer name and email shown in <code>apt show</code> output.</p>
23
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/VirtualPackageManager/index.ts#L33">src/VirtualPackageManager/index.ts:33</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="name"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Package name — lowercase, no spaces (e.g. <code>&quot;vim&quot;</code>, <code>&quot;build-essential&quot;</code>).</p>
24
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/VirtualPackageManager/index.ts#L27">src/VirtualPackageManager/index.ts:27</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="oninstall"><code class="tsd-tag">Optional</code><span>on<wbr/>Install</span><a href="#oninstall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">onInstall</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">vfs</span><span class="tsd-signature-symbol">:</span> <a href="../classes/VirtualFileSystem.html" class="tsd-signature-type tsd-kind-class">VirtualFileSystem</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">users</span><span class="tsd-signature-symbol">:</span> <a href="../classes/VirtualUserManager.html" class="tsd-signature-type tsd-kind-class">VirtualUserManager</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Hook called after all files are written.
25
+ Use to create directories, write config, or register shell commands.</p>
26
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/VirtualPackageManager/index.ts#L50">src/VirtualPackageManager/index.ts:50</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="onremove"><code class="tsd-tag">Optional</code><span>on<wbr/>Remove</span><a href="#onremove" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">onRemove</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">vfs</span><span class="tsd-signature-symbol">:</span> <a href="../classes/VirtualFileSystem.html" class="tsd-signature-type tsd-kind-class">VirtualFileSystem</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Hook called before VFS files are removed during uninstall.</p>
27
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/VirtualPackageManager/index.ts#L52">src/VirtualPackageManager/index.ts:52</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="section"><code class="tsd-tag">Optional</code><span>section</span><a href="#section" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">section</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Repository section (e.g. <code>&quot;utils&quot;</code>, <code>&quot;net&quot;</code>, <code>&quot;editors&quot;</code>, <code>&quot;devel&quot;</code>).</p>
28
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/VirtualPackageManager/index.ts#L43">src/VirtualPackageManager/index.ts:43</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="shortdesc"><code class="tsd-tag">Optional</code><span>short<wbr/>Desc</span><a href="#shortdesc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">shortDesc</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Short one-line summary shown in <code>apt search</code> results.</p>
29
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/VirtualPackageManager/index.ts#L37">src/VirtualPackageManager/index.ts:37</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="version"><span>version</span><a href="#version" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Debian-style version string (e.g. <code>&quot;2:9.0.1378-2&quot;</code>).</p>
30
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/VirtualPackageManager/index.ts#L29">src/VirtualPackageManager/index.ts:29</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#architecture"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>architecture</span></a><a href="#depends"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>depends</span></a><a href="#description"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>description</span></a><a href="#files"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>files</span></a><a href="#installedsizekb"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>installed<wbr/>Size<wbr/>Kb</span></a><a href="#maintainer"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>maintainer</span></a><a href="#name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#oninstall"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Install</span></a><a href="#onremove"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Remove</span></a><a href="#section"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>section</span></a><a href="#shortdesc"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>short<wbr/>Desc</span></a><a href="#version"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>version</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">typescript-virtual-container</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/docs/interfaces/PackageFile.html ADDED
@@ -0,0 +1,8 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PackageFile | typescript-virtual-container</title><meta name="description" content="Documentation for typescript-virtual-container"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">typescript-virtual-container</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">PackageFile</a></li></ul><h1>Interface PackageFile</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A single file entry written into the VFS when a package is installed.</p>
2
+ </div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">PackageFile</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#content">content</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#mode">mode</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#path">path</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/VirtualPackageManager/index.ts#L9">src/VirtualPackageManager/index.ts:9</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#content" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>content</span></a>
3
+ <a href="#mode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mode?</span></a>
4
+ <a href="#path" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>path</span></a>
5
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="content"><span>content</span><a href="#content" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">content</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Text content to write.</p>
6
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/VirtualPackageManager/index.ts#L13">src/VirtualPackageManager/index.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="mode"><code class="tsd-tag">Optional</code><span>mode</span><a href="#mode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">mode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>POSIX mode bits (default <code>0o644</code>; use <code>0o755</code> for executables).</p>
7
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/VirtualPackageManager/index.ts#L15">src/VirtualPackageManager/index.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="path"><span>path</span><a href="#path" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Absolute VFS destination path (e.g. <code>&quot;/usr/bin/vim&quot;</code>).</p>
8
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/VirtualPackageManager/index.ts#L11">src/VirtualPackageManager/index.ts:11</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#content"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>content</span></a><a href="#mode"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mode</span></a><a href="#path"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>path</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">typescript-virtual-container</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/docs/interfaces/RemoveOptions.html ADDED
@@ -0,0 +1,4 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RemoveOptions | typescript-virtual-container</title><meta name="description" content="Documentation for typescript-virtual-container"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">typescript-virtual-container</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">RemoveOptions</a></li></ul><h1>Interface RemoveOptions</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Optional behavior flags for remove operations.</p>
2
+ </div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">RemoveOptions</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#recursive">recursive</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/types/vfs.ts#L46">src/types/vfs.ts:46</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#recursive" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>recursive?</span></a>
3
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="recursive"><code class="tsd-tag">Optional</code><span>recursive</span><a href="#recursive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">recursive</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Allow deleting non-empty directory trees.</p>
4
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/types/vfs.ts#L48">src/types/vfs.ts:48</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#recursive"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>recursive</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">typescript-virtual-container</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/docs/interfaces/ShellEnv.html ADDED
@@ -0,0 +1,6 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ShellEnv | typescript-virtual-container</title><meta name="description" content="Documentation for typescript-virtual-container"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">typescript-virtual-container</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">ShellEnv</a></li></ul><h1>Interface ShellEnv</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Per-session shell environment (variables, last exit code).</p>
2
+ </div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ShellEnv</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#lastexitcode">lastExitCode</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#vars">vars</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/types/commands.ts#L98">src/types/commands.ts:98</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#lastexitcode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>last<wbr/>Exit<wbr/>Code</span></a>
3
+ <a href="#vars" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>vars</span></a>
4
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="lastexitcode"><span>last<wbr/>Exit<wbr/>Code</span><a href="#lastexitcode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">lastExitCode</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Exit status of the last executed command.</p>
5
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/types/commands.ts#L102">src/types/commands.ts:102</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="vars"><span>vars</span><a href="#vars" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">vars</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Environment variables visible to commands.</p>
6
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/types/commands.ts#L100">src/types/commands.ts:100</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#lastexitcode"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>last<wbr/>Exit<wbr/>Code</span></a><a href="#vars"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>vars</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">typescript-virtual-container</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/docs/interfaces/ShellModule.html ADDED
@@ -0,0 +1,14 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ShellModule | typescript-virtual-container</title><meta name="description" content="Documentation for typescript-virtual-container"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">typescript-virtual-container</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">ShellModule</a></li></ul><h1>Interface ShellModule</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Contract implemented by each shell command module.</p>
2
+ </div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ShellModule</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#aliases">aliases</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#category">category</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#description">description</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#name">name</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#params">params</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#run">run</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">ctx</span><span class="tsd-signature-symbol">:</span> <a href="CommandContext.html" class="tsd-signature-type tsd-kind-interface">CommandContext</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="CommandResult.html" class="tsd-signature-type tsd-kind-interface">CommandResult</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="CommandResult.html" class="tsd-signature-type tsd-kind-interface">CommandResult</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/types/commands.ts#L130">src/types/commands.ts:130</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#aliases" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>aliases?</span></a>
3
+ <a href="#category" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>category?</span></a>
4
+ <a href="#description" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>description?</span></a>
5
+ <a href="#name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a>
6
+ <a href="#params" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>params</span></a>
7
+ <a href="#run" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>run</span></a>
8
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="aliases"><code class="tsd-tag">Optional</code><span>aliases</span><a href="#aliases" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">aliases</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Optional alternative command names.</p>
9
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/types/commands.ts#L138">src/types/commands.ts:138</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="category"><code class="tsd-tag">Optional</code><span>category</span><a href="#category" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">category</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Category used for grouped help output.</p>
10
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/types/commands.ts#L142">src/types/commands.ts:142</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="description"><code class="tsd-tag">Optional</code><span>description</span><a href="#description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Short description shown in <code>help</code>.</p>
11
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/types/commands.ts#L140">src/types/commands.ts:140</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="name"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Primary command name used in CLI.</p>
12
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/types/commands.ts#L132">src/types/commands.ts:132</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="params"><span>params</span><a href="#params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">params</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Parameter help snippets displayed by help command.</p>
13
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/types/commands.ts#L134">src/types/commands.ts:134</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="run"><span>run</span><a href="#run" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">run</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">ctx</span><span class="tsd-signature-symbol">:</span> <a href="CommandContext.html" class="tsd-signature-type tsd-kind-interface">CommandContext</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="CommandResult.html" class="tsd-signature-type tsd-kind-interface">CommandResult</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="CommandResult.html" class="tsd-signature-type tsd-kind-interface">CommandResult</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Command handler implementation.</p>
14
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/types/commands.ts#L136">src/types/commands.ts:136</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#aliases"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>aliases</span></a><a href="#category"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>category</span></a><a href="#description"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>description</span></a><a href="#name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#params"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>params</span></a><a href="#run"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>run</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">typescript-virtual-container</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/docs/interfaces/ShellProperties.html ADDED
@@ -0,0 +1,14 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ShellProperties | typescript-virtual-container</title><meta name="description" content="Documentation for typescript-virtual-container"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">typescript-virtual-container</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">ShellProperties</a></li></ul><h1>Interface ShellProperties</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Virtual machine identity strings surfaced by system-info commands
2
+ (<code>uname</code>, <code>neofetch</code>, <code>lsb_release</code>, <code>/proc/version</code>, <code>/etc/os-release</code>).</p>
3
+ <p>Pass this as the second argument to <code>new VirtualShell()</code> to customise the
4
+ distro name, kernel version, and CPU architecture reported inside the shell.</p>
5
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-7">shell</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-0">VirtualShell</span><span class="hl-1">(</span><span class="hl-2">&quot;my-vm&quot;</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-5">kernel:</span><span class="hl-1"> </span><span class="hl-2">&quot;6.1.0+custom-amd64&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">os:</span><span class="hl-1"> </span><span class="hl-2">&quot;Acme GNU/Linux x64&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">arch:</span><span class="hl-1"> </span><span class="hl-2">&quot;x86_64&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">});</span>
6
+ </code><button type="button">Copy</button></pre>
7
+
8
+ </div></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ShellProperties</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#arch">arch</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#kernel">kernel</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#os">os</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/VirtualShell/index.ts#L35">src/VirtualShell/index.ts:35</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#arch" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>arch</span></a>
9
+ <a href="#kernel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>kernel</span></a>
10
+ <a href="#os" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>os</span></a>
11
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="arch"><span>arch</span><a href="#arch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">arch</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>CPU architecture label (e.g. <code>&quot;x86_64&quot;</code>, <code>&quot;aarch64&quot;</code>).</p>
12
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/VirtualShell/index.ts#L41">src/VirtualShell/index.ts:41</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="kernel"><span>kernel</span><a href="#kernel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">kernel</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Kernel version string (e.g. <code>&quot;1.0.0+itsrealfortune+1-amd64&quot;</code>).</p>
13
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/VirtualShell/index.ts#L37">src/VirtualShell/index.ts:37</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="os"><span>os</span><a href="#os" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">os</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Full OS description (e.g. <code>&quot;Fortune GNU/Linux x64&quot;</code>).</p>
14
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/VirtualShell/index.ts#L39">src/VirtualShell/index.ts:39</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#arch"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>arch</span></a><a href="#kernel"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>kernel</span></a><a href="#os"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>os</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">typescript-virtual-container</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/docs/interfaces/ShellStream.html ADDED
@@ -0,0 +1,11 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ShellStream | typescript-virtual-container</title><meta name="description" content="Documentation for typescript-virtual-container"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">typescript-virtual-container</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">ShellStream</a></li></ul><h1>Interface ShellStream</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Minimal interactive stream contract used by shell mode.</p>
2
+ </div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ShellStream</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-call-signature" href="#end-1">end</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#exit-1">exit</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#on-1">on</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;data&quot;</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chunk</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#on-2">on</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;close&quot;</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#write-1">write</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/types/streams.ts#L21">src/types/streams.ts:21</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#end" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>end</span></a>
3
+ <a href="#exit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>exit</span></a>
4
+ <a href="#on" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on</span></a>
5
+ <a href="#write" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>write</span></a>
6
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="end"><span>end</span><a href="#end" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="end-1"><span class="tsd-kind-call-signature">end</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#end-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Ends shell stream.</p>
7
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/types/streams.ts#L27">src/types/streams.ts:27</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="exit"><span>exit</span><a href="#exit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="exit-1"><span class="tsd-kind-call-signature">exit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#exit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets shell exit code on close.</p>
8
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">code</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/types/streams.ts#L25">src/types/streams.ts:25</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="on"><span>on</span><a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="on-1"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;data&quot;</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chunk</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#on-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Subscribes to incoming user input chunks.</p>
9
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">&quot;data&quot;</span></span></li><li><span><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chunk</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/types/streams.ts#L29">src/types/streams.ts:29</a></li></ul></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="on-2"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;close&quot;</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#on-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Subscribes to stream close event.</p>
10
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">&quot;close&quot;</span></span></li><li><span><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/types/streams.ts#L31">src/types/streams.ts:31</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="write"><span>write</span><a href="#write" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="write-1"><span class="tsd-kind-call-signature">write</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#write-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Writes text to shell output channel.</p>
11
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/types/streams.ts#L23">src/types/streams.ts:23</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#end"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>end</span></a><a href="#exit"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>exit</span></a><a href="#on"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on</span></a><a href="#write"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>write</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">typescript-virtual-container</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/docs/interfaces/SudoChallenge.html ADDED
@@ -0,0 +1,24 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SudoChallenge | typescript-virtual-container</title><meta name="description" content="Documentation for typescript-virtual-container"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">typescript-virtual-container</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">SudoChallenge</a></li></ul><h1>Interface SudoChallenge</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Deferred sudo challenge metadata returned by sudo command.</p>
2
+ </div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">SudoChallenge</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#commandline">commandLine</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#loginshell">loginShell</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#mode">mode</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;sudo&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;passwd&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;confirm&quot;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#onpassword">onPassword</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">shell</span><span class="tsd-signature-symbol">:</span> <a href="../classes/VirtualShell.html" class="tsd-signature-type tsd-kind-class">VirtualShell</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">nextPrompt</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">result</span><span class="tsd-signature-symbol">:</span> <a href="CommandResult.html" class="tsd-signature-type tsd-kind-interface">CommandResult</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#prompt">prompt</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#targetuser">targetUser</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#username">username</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/types/commands.ts#L39">src/types/commands.ts:39</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#commandline" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>command<wbr/>Line</span></a>
3
+ <a href="#loginshell" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>login<wbr/>Shell</span></a>
4
+ <a href="#mode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mode?</span></a>
5
+ <a href="#onpassword" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Password?</span></a>
6
+ <a href="#prompt" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prompt</span></a>
7
+ <a href="#targetuser" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>target<wbr/>User</span></a>
8
+ <a href="#username" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>username</span></a>
9
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="commandline"><span>command<wbr/>Line</span><a href="#commandline" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">commandLine</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div><div class="tsd-comment tsd-typography"><p>Command to execute after successful challenge; null for login shell.</p>
10
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/types/commands.ts#L45">src/types/commands.ts:45</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="loginshell"><span>login<wbr/>Shell</span><a href="#loginshell" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">loginShell</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>True when challenge targets interactive login shell.</p>
11
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/types/commands.ts#L47">src/types/commands.ts:47</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="mode"><code class="tsd-tag">Optional</code><span>mode</span><a href="#mode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">mode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;sudo&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;passwd&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;confirm&quot;</span></div><div class="tsd-comment tsd-typography"><p>Challenge mode.</p>
12
+ <ul>
13
+ <li><code>&quot;sudo&quot;</code> (default): verify <code>username</code>'s password, then run <code>commandLine</code>.</li>
14
+ <li><code>&quot;passwd&quot;</code>: multi-step new-password flow; <code>onPassword</code> handles each step.</li>
15
+ <li><code>&quot;confirm&quot;</code>: text confirmation flow (e.g. deluser); <code>onPassword</code> receives typed text.</li>
16
+ </ul>
17
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/types/commands.ts#L56">src/types/commands.ts:56</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="onpassword"><code class="tsd-tag">Optional</code><span>on<wbr/>Password</span><a href="#onpassword" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">onPassword</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">shell</span><span class="tsd-signature-symbol">:</span> <a href="../classes/VirtualShell.html" class="tsd-signature-type tsd-kind-class">VirtualShell</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">nextPrompt</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">result</span><span class="tsd-signature-symbol">:</span> <a href="CommandResult.html" class="tsd-signature-type tsd-kind-interface">CommandResult</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Optional async handler called when the user submits input.
18
+ Receives the typed text and the shell instance.
19
+ Returns a <code>CommandResult</code> written to the terminal, or <code>null</code> to show
20
+ another prompt (pass <code>nextPrompt</code> to change the prompt text).</p>
21
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/types/commands.ts#L63">src/types/commands.ts:63</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="prompt"><span>prompt</span><a href="#prompt" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prompt</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Prompt text shown before password input.</p>
22
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/types/commands.ts#L49">src/types/commands.ts:49</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="targetuser"><span>target<wbr/>User</span><a href="#targetuser" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">targetUser</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Target identity for elevated command.</p>
23
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/types/commands.ts#L43">src/types/commands.ts:43</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="username"><span>username</span><a href="#username" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>User currently requesting elevation.</p>
24
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/209b91736bb975ff0bab066428ddd94c5b28a080/src/types/commands.ts#L41">src/types/commands.ts:41</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#commandline"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>command<wbr/>Line</span></a><a href="#loginshell"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>login<wbr/>Shell</span></a><a href="#mode"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mode</span></a><a href="#onpassword"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Password</span></a><a href="#prompt"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prompt</span></a><a href="#targetuser"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>target<wbr/>User</span></a><a href="#username"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>username</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">typescript-virtual-container</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>