@webcontainer/api/api_reference.json

WebContainer Public API

{"id":0,"name":"@webcontainer/api","kind":1,"kindString":"Project","flags":{},"comment":{"summary":[{"kind":"text","text":"The WebContainer Public API allows you build custom applications on top of an in-browser Node.js runtime.\n\nIts main entrypoint is the "},{"kind":"inline-tag","tag":"@link","text":"WebContainer","target":5},{"kind":"text","text":" class."}]},"originalName":"","children":[{"id":501,"name":"PreviewMessageType","kind":8,"kindString":"Enumeration","flags":{},"comment":{"summary":[{"kind":"text","text":"This type is in a separate module so that localservice can import it\nwithout bundling all the other webcontainer specific stuff."}]},"children":[{"id":504,"name":"ConsoleError","kind":16,"kindString":"Enumeration Member","flags":{},"type":{"type":"literal","value":"PREVIEW_CONSOLE_ERROR"}},{"id":502,"name":"UncaughtException","kind":16,"kindString":"Enumeration Member","flags":{},"type":{"type":"literal","value":"PREVIEW_UNCAUGHT_EXCEPTION"}},{"id":503,"name":"UnhandledRejection","kind":16,"kindString":"Enumeration Member","flags":{},"type":{"type":"literal","value":"PREVIEW_UNHANDLED_REJECTION"}}],"groups":[{"title":"Enumeration Members","children":[504,502,503]}]},{"id":5,"name":"WebContainer","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"The main export of this library. An instance of "},{"kind":"code","text":"`WebContainer`"},{"kind":"text","text":" represents a runtime\nready to be used."}]},"children":[{"id":22,"name":"_tornDown","kind":1024,"kindString":"Property","flags":{"isPrivate":true},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"},{"id":20,"name":"fs","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Gives access to the underlying file system."}]},"type":{"type":"reference","id":191,"name":"FileSystemAPI"}},{"id":21,"name":"internal","kind":1024,"kindString":"Property","flags":{},"type":{"type":"reference","id":84,"name":"WebContainerInternal"}},{"id":78,"name":"path","kind":262144,"kindString":"Accessor","flags":{},"getSignature":{"id":79,"name":"path","kind":524288,"kindString":"Get signature","flags":{},"comment":{"summary":[{"kind":"text","text":"The default value of the "},{"kind":"code","text":"`PATH`"},{"kind":"text","text":" environment variable for processes started through "},{"kind":"inline-tag","tag":"@link","text":"spawn","target":30},{"kind":"text","text":"."}]},"type":{"type":"intrinsic","name":"string"}}},{"id":80,"name":"workdir","kind":262144,"kindString":"Accessor","flags":{},"getSignature":{"id":81,"name":"workdir","kind":524288,"kindString":"Get signature","flags":{},"comment":{"summary":[{"kind":"text","text":"The full path to the working directory (see "},{"kind":"inline-tag","tag":"@link","text":"FileSystemAPI","target":191},{"kind":"text","text":")."}]},"type":{"type":"intrinsic","name":"string"}}},{"id":23,"name":"_unsubscribeFromTokenChangedListener","kind":2048,"kindString":"Method","flags":{"isPrivate":true},"signatures":[{"id":24,"name":"_unsubscribeFromTokenChangedListener","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]},{"id":38,"name":"export","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":39,"name":"export","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Exports the provided "},{"kind":"code","text":"`path`"},{"kind":"text","text":" in the format provided."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```\nconst fileTree = await webcontainer.export('dist', { format: 'json' });\n```"}]}]},"parameters":[{"id":40,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The path to serialize."}]},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":345,"name":"FileSystemTree"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}},{"id":41,"name":"export","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":42,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":43,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intersection","types":[{"type":"reference","id":415,"name":"ExportOptions"},{"type":"reflection","declaration":{"id":44,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":45,"name":"format","kind":1024,"kindString":"Property","flags":{"isOptional":true},"type":{"type":"literal","value":"json"}}],"groups":[{"title":"Properties","children":[45]}]}}]}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":345,"name":"FileSystemTree"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}},{"id":46,"name":"export","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":47,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":48,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":415,"name":"ExportOptions"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","name":"Uint8Array","qualifiedName":"Uint8Array","package":"typescript"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":68,"name":"mount","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":69,"name":"mount","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Mounts a tree of files into the filesystem. This can be specified as a tree object ("},{"kind":"inline-tag","tag":"@link","text":"FileSystemTree","target":345},{"kind":"text","text":")\nor as a binary snapshot generated by ["},{"kind":"code","text":"`@webcontainer/snapshot`"},{"kind":"text","text":"](https://www.npmjs.com/package/@webcontainer/snapshot)."}]},"parameters":[{"id":70,"name":"snapshotOrTree","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"A tree of files, or a binary snapshot. Note that binary payloads will be transferred."}]},"type":{"type":"union","types":[{"type":"reference","name":"ArrayBuffer","qualifiedName":"ArrayBuffer","package":"typescript"},{"type":"reference","id":345,"name":"FileSystemTree"},{"type":"reference","name":"Uint8Array","qualifiedName":"Uint8Array","package":"typescript"}]}},{"id":71,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reflection","declaration":{"id":72,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":73,"name":"mountPoint","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Specifies a nested path where the tree should be mounted."}]},"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[73]}]}}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":49,"name":"on","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":50,"name":"on","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Listens for "},{"kind":"code","text":"`port`"},{"kind":"text","text":" events, which are emitted when a port is opened or closed by some process."}]},"parameters":[{"id":51,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"literal","value":"port"}},{"id":52,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":139,"name":"PortListener"}}],"type":{"type":"reference","id":389,"name":"Unsubscribe"}},{"id":53,"name":"on","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Listens for "},{"kind":"code","text":"`server-ready`"},{"kind":"text","text":" events, emitted when a running server is listening for incoming\nconnections and ready to answer requests."}]},"parameters":[{"id":54,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"literal","value":"server-ready"}},{"id":55,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":145,"name":"ServerReadyListener"}}],"type":{"type":"reference","id":389,"name":"Unsubscribe"}},{"id":56,"name":"on","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Listens for "},{"kind":"code","text":"`preview-message`"},{"kind":"text","text":" events, emitted when a preview sends a "},{"kind":"code","text":"`PreviewMessage`"},{"kind":"text","text":"."}]},"parameters":[{"id":57,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"literal","value":"preview-message"}},{"id":58,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":150,"name":"PreviewMessageListener"}}],"type":{"type":"reference","id":389,"name":"Unsubscribe"}},{"id":59,"name":"on","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Listens for "},{"kind":"code","text":"`error`"},{"kind":"text","text":" events, emitted when an internal error is triggered."}]},"parameters":[{"id":60,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"literal","value":"error"}},{"id":61,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":154,"name":"ErrorListener"}}],"type":{"type":"reference","id":389,"name":"Unsubscribe"}},{"id":62,"name":"on","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Listens for "},{"kind":"code","text":"`xdg-open`"},{"kind":"text","text":" events, emitted when the "},{"kind":"code","text":"`xdg-open`"},{"kind":"text","text":" command is invoked."}]},"parameters":[{"id":63,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"literal","value":"xdg-open"}},{"id":64,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":160,"name":"OpenListener"}}],"type":{"type":"reference","id":389,"name":"Unsubscribe"}},{"id":65,"name":"on","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Listens for "},{"kind":"code","text":"`code`"},{"kind":"text","text":" events, emitted when the "},{"kind":"code","text":"`code`"},{"kind":"text","text":" command is invoked."}]},"parameters":[{"id":66,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"literal","value":"code"}},{"id":67,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":164,"name":"CodeListener"}}],"type":{"type":"reference","id":389,"name":"Unsubscribe"}}]},{"id":74,"name":"setPreviewScript","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":75,"name":"setPreviewScript","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Set a custom script to be injected into all previews. When this function is called, every\nfuture page reload will contain the provided script tag on all HTML responses.\n\nNote:\n\nWhen this function resolves, every preview reloaded _after_ will have the new script.\nExisting preview have to be explicitely reloaded.\n\nTo reload a preview you can use "},{"kind":"code","text":"`reloadPreview`"},{"kind":"text","text":"."}]},"parameters":[{"id":76,"name":"scriptSrc","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"Source for the script tag."}]},"type":{"type":"intrinsic","name":"string"}},{"id":77,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Options to define which type of script this is."}]},"type":{"type":"reference","id":393,"name":"PreviewScriptOptions"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":30,"name":"spawn","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":31,"name":"spawn","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Spawns a process."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```\nconst install = await webcontainer.spawn('npm', ['i']);\n```"}]}]},"parameters":[{"id":32,"name":"command","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The program to be executed."}]},"type":{"type":"intrinsic","name":"string"}},{"id":33,"name":"args","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The command-line arguments for the program."}]},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":34,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","id":299,"name":"SpawnOptions"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":285,"name":"WebContainerProcess"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}},{"id":35,"name":"spawn","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Spawns a process without command-line arguments."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```\nconst install = await webcontainer.spawn('yarn');\n```"}]}]},"parameters":[{"id":36,"name":"command","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The program to be executed."}]},"type":{"type":"intrinsic","name":"string"}},{"id":37,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","id":299,"name":"SpawnOptions"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":285,"name":"WebContainerProcess"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":82,"name":"teardown","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":83,"name":"teardown","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Destroys the WebContainer instance, turning it unusable, and releases its resources. After this,\na new WebContainer instance can be obtained by calling "},{"kind":"inline-tag","tag":"@link","text":"`boot`","target":8},{"kind":"text","text":".\n\nAll entities derived from this instance (e.g. processes, the file system, etc.) also become unusable\nafter calling this method."}]},"type":{"type":"intrinsic","name":"void"}}]},{"id":8,"name":"boot","kind":2048,"kindString":"Method","flags":{"isStatic":true},"signatures":[{"id":9,"name":"boot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Boots a WebContainer. Only a single instance of WebContainer can be booted concurrently\n(see "},{"kind":"inline-tag","tag":"@link","text":"`teardown`","target":82},{"kind":"text","text":").\n\nBooting WebContainer is an expensive operation."}]},"parameters":[{"id":10,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":134,"name":"BootOptions"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":5,"name":"WebContainer"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]}],"groups":[{"title":"Properties","children":[22,20,21]},{"title":"Accessors","children":[78,80]},{"title":"Methods","children":[23,38,68,49,74,30,82,8]}]},{"id":84,"name":"WebContainerInternal","kind":128,"kindString":"Class","flags":{},"children":[{"id":85,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"signatures":[{"id":86,"name":"new WebContainerInternal","kind":16384,"kindString":"Constructor signature","flags":{},"parameters":[{"id":87,"name":"previewScript","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"Exchange messages with preview scripts."}]},"type":{"type":"reference","id":310,"name":"PreviewScriptAPI"}}],"type":{"type":"reference","id":84,"name":"WebContainerInternal"}}]},{"id":89,"name":"previewScript","kind":1024,"kindString":"Property","flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Exchange messages with preview scripts."}]},"type":{"type":"reference","id":310,"name":"PreviewScriptAPI"}},{"id":100,"name":"fileSearch","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":101,"name":"fileSearch","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":102,"name":"patterns","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":103,"name":"cwd","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":104,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","typeArguments":[{"type":"reference","id":460,"name":"FileSearchOptions"}],"name":"Partial","qualifiedName":"Partial","package":"typescript"}}],"type":{"type":"reference","typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"string"}}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":110,"name":"getProcesses","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":111,"name":"getProcesses","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","typeArguments":[{"type":"array","elementType":{"type":"reflection","declaration":{"id":112,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":113,"name":"pid","kind":1024,"kindString":"Property","flags":{},"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","children":[113]}]}}}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":114,"name":"onProcessesRemove","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":115,"name":"onProcessesRemove","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":116,"name":"cb","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":117,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":118,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":119,"name":"process","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":120,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":121,"name":"pid","kind":1024,"kindString":"Property","flags":{},"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","children":[121]}]}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reflection","declaration":{"id":122,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":123,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}}]},{"id":124,"name":"serialize","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":125,"name":"serialize","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":126,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":127,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","id":261,"name":"GlobOptions"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","name":"Uint8Array","qualifiedName":"Uint8Array","package":"typescript"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":131,"name":"setCORSAuthToken","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":132,"name":"setCORSAuthToken","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":133,"name":"token","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":128,"name":"setCORSProxy","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":129,"name":"setCORSProxy","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":130,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","id":498,"name":"ProxyOptions"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":105,"name":"textSearch","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":106,"name":"textSearch","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":107,"name":"pattern","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":108,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","typeArguments":[{"type":"reference","id":469,"name":"TextSearchOptions"}],"name":"Partial","qualifiedName":"Partial","package":"typescript"}},{"id":109,"name":"onProgress","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","id":493,"name":"TextSearchOnProgressCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"reference","id":482,"name":"TextSearchMatch"}}],"name":"Map","qualifiedName":"Map","package":"typescript"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":91,"name":"watchPaths","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":92,"name":"watchPaths","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":93,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":176,"name":"WatchPathsOptions"}},{"id":94,"name":"cb","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":95,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":96,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":97,"name":"events","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"array","elementType":{"type":"reference","id":185,"name":"PathWatcherEvent"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reflection","declaration":{"id":98,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":99,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}}]}],"groups":[{"title":"Constructors","children":[85]},{"title":"Properties","children":[89]},{"title":"Methods","children":[100,110,114,124,131,128,105,91]}]},{"id":348,"name":"AuthAPI","kind":256,"kindString":"Interface","flags":{},"comment":{"summary":[{"kind":"text","text":"Module to authenticate users. Once authenticated, the WebContainer instance\ncan fetch private packages to which the user has access.\n\nIf you use this module, you should call "},{"kind":"code","text":"`auth.init()`"},{"kind":"text","text":" once at application initialization time.\nIf you do server side rendering, it should be called on any page that uses the API.\n\nThe AuthAPI uses OAuth 2.0 with PKCE and reads parameters from the URL:\n\n - "},{"kind":"code","text":"`code`"},{"kind":"text","text":":  This contains the OAuth code needed to get credentials.\n - "},{"kind":"code","text":"`error`"},{"kind":"text","text":": This contains an error message if authentication fails.\n            Typically, if the user declines the authorization."}]},"children":[{"id":349,"name":"init","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":350,"name":"init","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Intialize the authentication for use in WebContainer."}]},"parameters":[{"id":351,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"Options to initialize the authentication of users."}]},"type":{"type":"reference","id":381,"name":"AuthInitOptions"}}],"type":{"type":"union","types":[{"type":"reflection","declaration":{"id":352,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":353,"name":"status","kind":1024,"kindString":"Property","flags":{},"type":{"type":"union","types":[{"type":"literal","value":"need-auth"},{"type":"literal","value":"authorized"}]}}],"groups":[{"title":"Properties","children":[353]}]}},{"type":"reference","id":385,"name":"AuthFailedError"}]}}]},{"id":359,"name":"loggedIn","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":360,"name":"loggedIn","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Returns a promise that resolves when the user authorized your application.\nThis promise is guaranteed to never be rejected.\n\nIf the user never authorizes or declines your application, this promise never\nresolves.\n\n### Example:\n\n"},{"kind":"code","text":"```ts\nconst instance = await WebContainer.boot();\n\n// wait until the user is logged in\nawait auth.loggedIn();\n\n// we can now fetch packages\nawait instance.spawn('npm', ['install']);\n```"}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":361,"name":"logout","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":362,"name":"logout","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Logout the user and clear any credentials that were saved locally."}]},"parameters":[{"id":363,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"If "},{"kind":"code","text":"`ignoreRevokeError`"},{"kind":"text","text":" is set and the revocation failed, the locally-saved credentials are discarded nonetheless."}]},"type":{"type":"reflection","declaration":{"id":364,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":365,"name":"ignoreRevokeError","kind":1024,"kindString":"Property","flags":{"isOptional":true},"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[365]}]}}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":366,"name":"on","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":367,"name":"on","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Listens for 'logged-out' events, which are emitted when the credentials are revoked, meaning the user needs to re-authenticate."}]},"parameters":[{"id":368,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"literal","value":"logged-out"}},{"id":369,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":370,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":371,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","id":389,"name":"Unsubscribe"}},{"id":372,"name":"on","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Listens for 'auth-failed' events, which are emitted when the user declines authorization in another tab / popup."}]},"parameters":[{"id":373,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"literal","value":"auth-failed"}},{"id":374,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":375,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":376,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":377,"name":"reason","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":378,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":380,"name":"description","kind":1024,"kindString":"Property","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":379,"name":"error","kind":1024,"kindString":"Property","flags":{},"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[380,379]}]}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","id":389,"name":"Unsubscribe"}}]},{"id":354,"name":"startAuthFlow","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":355,"name":"startAuthFlow","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"This starts the OAuth flow, redirecting the current page to the\nStackBlitz editor to authenticate the user."}]},"parameters":[{"id":356,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"If "},{"kind":"code","text":"`options.popup`"},{"kind":"text","text":" is set to true, then instead of redirecting the current page, a popup is opened."}]},"type":{"type":"reflection","declaration":{"id":357,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":358,"name":"popup","kind":1024,"kindString":"Property","flags":{"isOptional":true},"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[358]}]}}}],"type":{"type":"intrinsic","name":"void"}}]}],"groups":[{"title":"Methods","children":[349,359,361,366,354]}]},{"id":385,"name":"AuthFailedError","kind":256,"kindString":"Interface","flags":{},"comment":{"summary":[{"kind":"text","text":"Authentication error used when authentication fails, likely because the user refused to grant\naccess or because they don't have permission."}]},"children":[{"id":388,"name":"description","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"A detailed description of the error."}]},"type":{"type":"intrinsic","name":"string"}},{"id":387,"name":"error","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"A short description of the error."}]},"type":{"type":"intrinsic","name":"string"}},{"id":386,"name":"status","kind":1024,"kindString":"Property","flags":{},"type":{"type":"literal","value":"auth-failed"}}],"groups":[{"title":"Properties","children":[388,387,386]}]},{"id":381,"name":"AuthInitOptions","kind":256,"kindString":"Interface","flags":{},"comment":{"summary":[{"kind":"text","text":"Options provided to "},{"kind":"code","text":"`auth.init(...)`"},{"kind":"text","text":"."}]},"children":[{"id":383,"name":"clientId","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The client id for this OAuth application."}]},"type":{"type":"intrinsic","name":"string"}},{"id":382,"name":"editorOrigin","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"StackBlitz' origin."}],"blockTags":[{"tag":"@default","content":[{"kind":"text","text":"https://stackblitz.com"}]}]},"type":{"type":"intrinsic","name":"string"}},{"id":384,"name":"scope","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"OAuth scope."}],"blockTags":[{"tag":"@see","content":[{"kind":"text","text":"https://www.rfc-editor.org/rfc/rfc6749#section-3.3"}]}]},"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[383,382,384]}]},{"id":397,"name":"BasePreviewMessage","kind":256,"kindString":"Interface","flags":{},"children":[{"id":402,"name":"hash","kind":1024,"kindString":"Property","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":400,"name":"pathname","kind":1024,"kindString":"Property","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":399,"name":"port","kind":1024,"kindString":"Property","flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":398,"name":"previewId","kind":1024,"kindString":"Property","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":401,"name":"search","kind":1024,"kindString":"Property","flags":{},"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[402,400,399,398,401]}]},{"id":134,"name":"BootOptions","kind":256,"kindString":"Interface","flags":{},"children":[{"id":135,"name":"coep","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The value of the "},{"kind":"inline-tag","tag":"@link","text":"COEP","target":"https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cross-Origin-Embedder-Policy"},{"kind":"text","text":" header\nused to load your application.\n\nChoosing 'none' will result in no cross-origin isolation headers being used. This will only work on Chromium-based\nbrowsers as long as an Origin Trial is supported.\n\nThis value is fixed the first time a WebContainer is booted, and cannot be changed in successive reboots.\n\nFor more info about cross-origin isolation, see our "},{"kind":"inline-tag","tag":"@link","text":"docs","target":"https://webcontainers.io/guides/quickstart"},{"kind":"text","text":"."}]},"type":{"type":"union","types":[{"type":"literal","value":"none"},{"type":"literal","value":"require-corp"},{"type":"literal","value":"credentialless"}]}},{"id":138,"name":"experimentalNode","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether to enable the experimental Node.js runtime."}]},"type":{"type":"intrinsic","name":"boolean"}},{"id":137,"name":"forwardPreviewErrors","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether errors occurring in preview iframes on the current page should be forwarded\nto the parent page. Captured errors originate from:\n\n - Calls to "},{"kind":"code","text":"`console.error`"},{"kind":"text","text":"\n - Any "},{"kind":"code","text":"`unhandledrejection`"},{"kind":"text","text":" events on "},{"kind":"code","text":"`window`"},{"kind":"text","text":"\n - Any uncaught "},{"kind":"code","text":"`error`"},{"kind":"text","text":" events on "},{"kind":"code","text":"`window`"},{"kind":"text","text":"\n\nIf set to 'exceptions-only', 'console.error's are not forwarded."}],"blockTags":[{"tag":"@default","content":[{"kind":"text","text":"false"}]}]},"type":{"type":"union","types":[{"type":"intrinsic","name":"boolean"},{"type":"literal","value":"exceptions-only"}]}},{"id":136,"name":"workdirName","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Sets the _folder name_ for the working directory of your WebContainer instance (see "},{"kind":"inline-tag","tag":"@link","text":"FileSystemAPI","target":191},{"kind":"text","text":").\nIf not provided, it will be auto-generated.\n\nThis is mostly a \"cosmetic\" option."}]},"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[135,138,137,136]}]},{"id":420,"name":"CodeEvent","kind":256,"kindString":"Interface","flags":{},"children":[{"id":421,"name":"files","kind":1024,"kindString":"Property","flags":{},"type":{"type":"array","elementType":{"type":"reference","id":422,"name":"CodeEventFile"}}}],"groups":[{"title":"Properties","children":[421]}]},{"id":422,"name":"CodeEventFile","kind":256,"kindString":"Interface","flags":{},"children":[{"id":425,"name":"column","kind":1024,"kindString":"Property","flags":{"isOptional":true},"type":{"type":"intrinsic","name":"number"}},{"id":423,"name":"filepath","kind":1024,"kindString":"Property","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":424,"name":"line","kind":1024,"kindString":"Property","flags":{"isOptional":true},"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","children":[425,423,424]}]},{"id":403,"name":"ConsoleErrorMessage","kind":256,"kindString":"Interface","flags":{},"children":[{"id":405,"name":"args","kind":1024,"kindString":"Property","flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}},{"id":406,"name":"stack","kind":1024,"kindString":"Property","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":404,"name":"type","kind":1024,"kindString":"Property","flags":{},"type":{"type":"reference","id":504,"name":"ConsoleError"}}],"groups":[{"title":"Properties","children":[405,406,404]}]},{"id":169,"name":"DirEnt","kind":256,"kindString":"Interface","flags":{},"comment":{"summary":[{"kind":"text","text":"A representation of a directory entry,\nsee "},{"kind":"inline-tag","tag":"@link","text":"the Node.js API","target":"https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#class-fsdirent"},{"kind":"text","text":"."}]},"children":[{"id":170,"name":"name","kind":1024,"kindString":"Property","flags":{},"type":{"type":"reference","id":175,"name":"T"}},{"id":173,"name":"isDirectory","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":174,"name":"isDirectory","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"boolean"}}]},{"id":171,"name":"isFile","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":172,"name":"isFile","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"boolean"}}]}],"groups":[{"title":"Properties","children":[170]},{"title":"Methods","children":[173,171]}],"typeParameters":[{"id":175,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}]},{"id":335,"name":"DirectoryNode","kind":256,"kindString":"Interface","flags":{},"comment":{"summary":[{"kind":"text","text":"Represents a directory, see "},{"kind":"inline-tag","tag":"@link","text":"FileSystemTree","target":345},{"kind":"text","text":"."}]},"children":[{"id":336,"name":"directory","kind":1024,"kindString":"Property","flags":{},"type":{"type":"reference","id":345,"name":"FileSystemTree"}}],"groups":[{"title":"Properties","children":[336]}]},{"id":415,"name":"ExportOptions","kind":256,"kindString":"Interface","flags":{},"children":[{"id":418,"name":"excludes","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Globbing patterns to exclude files from the export."}]},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":416,"name":"format","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The format of the export."}],"blockTags":[{"tag":"@default","content":[{"kind":"text","text":"json"}]}]},"type":{"type":"union","types":[{"type":"literal","value":"json"},{"type":"literal","value":"binary"},{"type":"literal","value":"zip"}]}},{"id":417,"name":"includes","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Globbing patterns to include files from within excluded folders."}]},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"groups":[{"title":"Properties","children":[418,416,417]}]},{"id":337,"name":"FileNode","kind":256,"kindString":"Interface","flags":{},"comment":{"summary":[{"kind":"text","text":"Represents a file, see "},{"kind":"inline-tag","tag":"@link","text":"FileSystemTree","target":345},{"kind":"text","text":"."}]},"children":[{"id":338,"name":"file","kind":1024,"kindString":"Property","flags":{},"type":{"type":"reflection","declaration":{"id":339,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":340,"name":"contents","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The contents of the file, either as a UTF-8 string or as raw binary."}]},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","name":"Uint8Array","qualifiedName":"Uint8Array","package":"typescript"}]}}],"groups":[{"title":"Properties","children":[340]}]}}}],"groups":[{"title":"Properties","children":[338]}]},{"id":460,"name":"FileSearchOptions","kind":256,"kindString":"Interface","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@unstableInternal","content":[]}]},"children":[{"id":463,"name":"excludes","kind":1024,"kindString":"Property","flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":465,"name":"gitignore","kind":1024,"kindString":"Property","flags":{},"type":{"type":"intrinsic","name":"boolean"}},{"id":464,"name":"globalIgnoreFiles","kind":1024,"kindString":"Property","flags":{},"type":{"type":"intrinsic","name":"boolean"}},{"id":461,"name":"homeDir","kind":1024,"kindString":"Property","flags":{"isOptional":true},"type":{"type":"intrinsic","name":"string"}},{"id":467,"name":"ignoreSymlinks","kind":1024,"kindString":"Property","flags":{},"type":{"type":"intrinsic","name":"boolean"}},{"id":462,"name":"includes","kind":1024,"kindString":"Property","flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":466,"name":"requireGit","kind":1024,"kindString":"Property","flags":{},"type":{"type":"intrinsic","name":"boolean"}},{"id":468,"name":"resultLimit","kind":1024,"kindString":"Property","flags":{},"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","children":[463,465,464,461,467,462,466,468]}]},{"id":191,"name":"FileSystemAPI","kind":256,"kindString":"Interface","flags":{},"comment":{"summary":[{"kind":"text","text":"Interface to interact directly with the WebContainer filesystem. Modeled after\n"},{"kind":"inline-tag","tag":"@link","text":"`fs.promises`","target":"https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#promises-api"},{"kind":"text","text":" in Node.\n\nFile system operations exposed here are scoped to the working directory: a given folder predetermined at boot time.\nAll paths are resolved with respect to this working directory."}]},"children":[{"id":231,"name":"mkdir","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":232,"name":"mkdir","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":233,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":234,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reflection","declaration":{"id":235,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":236,"name":"recursive","kind":1024,"kindString":"Property","flags":{"isOptional":true},"type":{"type":"literal","value":false}}],"groups":[{"title":"Properties","children":[236]}]}}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}},{"id":237,"name":"mkdir","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":238,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":239,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":240,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":241,"name":"recursive","kind":1024,"kindString":"Property","flags":{},"type":{"type":"literal","value":true}}],"groups":[{"title":"Properties","children":[241]}]}}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":217,"name":"readFile","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":218,"name":"readFile","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":219,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":220,"name":"encoding","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"literal","value":null}}],"type":{"type":"reference","typeArguments":[{"type":"reference","name":"Uint8Array","qualifiedName":"Uint8Array","package":"typescript"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}},{"id":221,"name":"readFile","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":222,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":223,"name":"encoding","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":309,"name":"BufferEncoding"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":192,"name":"readdir","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":193,"name":"readdir","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":194,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":195,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"literal","value":"buffer"},{"type":"reflection","declaration":{"id":196,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":197,"name":"encoding","kind":1024,"kindString":"Property","flags":{},"type":{"type":"literal","value":"buffer"}},{"id":198,"name":"withFileTypes","kind":1024,"kindString":"Property","flags":{"isOptional":true},"type":{"type":"literal","value":false}}],"groups":[{"title":"Properties","children":[197,198]}]}}]}}],"type":{"type":"reference","typeArguments":[{"type":"array","elementType":{"type":"reference","name":"Uint8Array","qualifiedName":"Uint8Array","package":"typescript"}}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}},{"id":199,"name":"readdir","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":200,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":201,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reflection","declaration":{"id":202,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":203,"name":"encoding","kind":1024,"kindString":"Property","flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","id":309,"name":"BufferEncoding"}]}},{"id":204,"name":"withFileTypes","kind":1024,"kindString":"Property","flags":{"isOptional":true},"type":{"type":"literal","value":false}}],"groups":[{"title":"Properties","children":[203,204]}]}},{"type":"reference","id":309,"name":"BufferEncoding"}]}}],"type":{"type":"reference","typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"string"}}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}},{"id":205,"name":"readdir","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":206,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":207,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":208,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":209,"name":"encoding","kind":1024,"kindString":"Property","flags":{},"type":{"type":"literal","value":"buffer"}},{"id":210,"name":"withFileTypes","kind":1024,"kindString":"Property","flags":{},"type":{"type":"literal","value":true}}],"groups":[{"title":"Properties","children":[209,210]}]}}}],"type":{"type":"reference","typeArguments":[{"type":"array","elementType":{"type":"reference","id":169,"typeArguments":[{"type":"reference","name":"Uint8Array","qualifiedName":"Uint8Array","package":"typescript"}],"name":"DirEnt"}}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}},{"id":211,"name":"readdir","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":212,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":213,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":214,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":215,"name":"encoding","kind":1024,"kindString":"Property","flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","id":309,"name":"BufferEncoding"}]}},{"id":216,"name":"withFileTypes","kind":1024,"kindString":"Property","flags":{},"type":{"type":"literal","value":true}}],"groups":[{"title":"Properties","children":[215,216]}]}}}],"type":{"type":"reference","typeArguments":[{"type":"array","elementType":{"type":"reference","id":169,"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"DirEnt"}}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":249,"name":"rename","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":250,"nam