Project: Kui (App Definition and Development / Application Definition & Image Build)
File: kui_shell_plugin_core_support.NotebookVFS.md

/ / NotebookVFS .NotebookVFS `TrieVFS`<`NotebookLeaf`[``"data"``]\> `NotebookVFS` `VFS` new NotebookVFS(`mountPath?`, `trie?`) | Name | Type | | :-- | :- | | `mountPath?` | `string` | | `trie?` | `any` | TrieVFS.TrieVFS<NotebookLeaf['data']\>.constructor plugins/plugin-bash-like/fs/mdist/vfs/TrieVFS.d.ts:21 `Readonly` isLocal: `false` VFS.isLocal TrieVFS.TrieVFS.isLocal plugins/plugin-bash-like/fs/mdist/vfs/TrieVFS.d.ts:18 `Readonly` isVirtual: `true` VFS.isVirtual TrieVFS.TrieVFS.isVirtual plugins/plugin-bash-like/fs/mdist/vfs/TrieVFS.d.ts:19 `Readonly` mountPath: `string` VFS.mountPath TrieVFS.TrieVFS.mountPath plugins/plugin-bash-like/fs/mdist/vfs/TrieVFS.d.ts:16 `Protected` `Readonly` prefix: `RegExp` TrieVFS.TrieVFS.prefix plugins/plugin-bash-like/fs/mdist/vfs/TrieVFS.d.ts:20 `Protected` `Readonly` trie: `any` TrieVFS.TrieVFS.trie plugins/plugin-bash-like/fs/mdist/vfs/TrieVFS.d.ts:17 cp(`_`, `srcFilepaths`, `dstFilepath`): `Promise`<`string`\> Insert filepath into directory | Name | Type | | :- | : | | `_` | `any` | | `srcFilepaths` | `string`[] | | `dstFilepath` | `string` | `Promise`<`string`\> VFS.cp TrieVFS.TrieVFS.cp plugins/plugin-bash-like/fs/mdist/vfs/TrieVFS.d.ts:62 fslice(`filename`, `offset`, `length`): `Promise`<`string`\> Fetch content slice | Name | Type | | : | :- | | `filename` | `string` | | `offset` | `number` | | `length` | `number` | `Promise`<`string`\> VFS.fslice TrieVFS.TrieVFS.fslice plugins/plugin-bash-like/fs/mdist/vfs/TrieVFS.d.ts:69 fstat(`opts`, `filepath`, `withData`, `enoentOk`): `Promise`<`FStat`\> Fetch contents | Name | Type | | : | : | | `opts` | `Pick`<`EvaluatorArgs`<`ParsedOptions`\>, `"REPL"` \| `"parsedOptions"`\> | | `filepath` | `string` | | `withData` | `boolean` | | `enoentOk` | `boolean` | `Promise`<`FStat`\> VFS.fstat TrieVFS.TrieVFS.fstat plugins/plugin-bash-like/fs/mdist/vfs/TrieVFS.d.ts:66 fwrite(`opts`, `filepath`, `data`): `Promise`<`void`\> | Name | Type | | : | : | | `opts` | `Pick`<`EvaluatorArgs`<`ParsedOptions`\>, `"REPL"`\> | | `filepath` | `string` | | `data` | `string` \| `Buffer` | `Promise`<`void`\> VFS.fwrite TrieVFS.TrieVFS.fwrite plugins/plugin-bash-like/fs/mdist/vfs/TrieVFS.d.ts:67 `Protected` isLeaf(`entry`): entry is Leaf<Object\> | Name | Type | | : | :-- | | `entry` | `Leaf`<{ `srcFilepath`: `string` }\> \| `BaseEntry` | entry is Leaf<Object\> TrieVFS.TrieVFS.isLeaf plugins/plugin-bash-like/fs/mdist/vfs/TrieVFS.d.ts:25 `Private` load(`data`): `Promise`<`string`\> Load Notebook data from bundles | Name | Type | | :-- | :- | | `data` | `Object` | | `data.srcFilepath` | `string` | `Promise`<`string`\> `Protected` loadAsString(`leaf`): `Promise`<`string`\> | Name | Type | | :-- | :- | | `leaf` | `NotebookLeaf` | `Promise`<`string`\> TrieVFS.TrieVFS.loadAsString ls(`namedParameters`, `filepaths`): `Promise`<{ `dirent`: { `isDirectory`: `boolean` ; `isExecutable`: `boolean` ; `isFile`: `boolean` ; `isSpecial`: `boolean` ; `isSymbolicLink`: `boolean` ; `mount`: { `isLocal`: `boolean` ; `mountPath`: `string` } ; `permissions`: `string` ; `username`: `string` } ; `name`: `string` ; `nameForDisplay`: `string` ; `path`: `string` ; `stats`: { `gid`: `number` ; `mode`: `number` ; `mtimeMs`: `number` ; `size`: `number` ; `uid`: `number` } ; `viewer`: `string` }[]\> | Name | Type | | : | : | | `namedParameters` | `Pick`<`EvaluatorArgs`<`KuiGlobOptions`\>, `"tab"` \| `"REPL"` \| `"parsedOptions"`\> | | `filepaths` | `string`[] | `Promise`<{ `dirent`: { `isDirectory`: `boolean` ; `isExecutable`: `boolean` ; `isFile`: `boolean` ; `isSpecial`: `boolean` ; `isSymbolicLink`: `boolean` ; `mount`: { `isLocal`: `boolean` ; `mountPath`: `string` } ; `permissions`: `string` ; `username`: `string` } ; `name`: `string` ; `nameForDisplay`: `string` ; `path`: `string` ; `stats`: { `gid`: `number` ; `mode`: `number` ; `mtimeMs`: `number` ; `size`: `number` ; `uid`: `number` } ; `viewer`: `string` }[]\> VFS.ls TrieVFS.TrieVFS.ls plugins/plugin-bash-like/fs/mdist/vfs/TrieVFS.d.ts:35 mkdir(`opts`): `Promise`<`void`\> Create a directory/bucket | Name | Type | | :-- | : | | `opts` | `Pick`<`EvaluatorArgs`<`ParsedOptions`\>, `"argvNoOptions"`\> | `Promise`<`void`\> VFS.mkdir TrieVFS.TrieVFS.mkdir plugins/plugin-bash-like/fs/mdist/vfs/TrieVFS.d.ts:71 `Protected` nameForDisplay(`name`): `Promise`<`string`\> | Name | Type | | :-- | :- | | `name` | `string` | `Promise`<`string`\> TrieVFS.TrieVFS.nameForDisplay rm(): `Promise`<`string` \| `boolean`\> Remove filepath `Promise`<`string` \| `boolean`\> VFS.rm TrieVFS.TrieVFS.rm plugins/plugin-bash-like/fs/mdist/vfs/TrieVFS.d.ts:64 rmdir(): `Promise`<`void`\> Remove a directory/bucket `Promise`<`void`\> VFS.rmdir TrieVFS.TrieVFS.rmdir plugins/plugin-bash-like/fs/mdist/vfs/TrieVFS.d.ts:73 `Protected` trieGet(`filepath`): `BaseEntry`[] | Name | Type | | : | :- | | `filepath` | `string` | `BaseEntry`[] TrieVFS.TrieVFS.trieGet plugins/plugin-bash-like/fs/mdist/vfs/TrieVFS.d.ts:29 `Protected` viewer(): `string` `string` TrieVFS.TrieVFS.viewer