@webcontainer/snapshot/api_reference.json

Build filesystem snapshots for the WebContainer API

{"id":0,"name":"@webcontainer/snapshot","kind":1,"kindString":"Project","flags":{},"originalName":"","children":[{"id":1,"name":"snapshot","kind":64,"kindString":"Function","flags":{},"signatures":[{"id":2,"name":"snapshot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Traverses the folder at "},{"kind":"code","text":"`root`"},{"kind":"text","text":" and builds a binary snapshot. The returned buffer is suitable to\nbe loaded by "},{"kind":"code","text":"`WebContainer#mount()`"},{"kind":"text","text":"."}]},"parameters":[{"id":3,"name":"root","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","name":"Buffer","qualifiedName":"global.Buffer","package":"@types/node"}],"name":"Promise","qualifiedName":"Promise","package":"typescript"}}]}],"groups":[{"title":"Functions","children":[1]}]}