diff --git a/assets/highlight.css b/assets/highlight.css index fb5f73e..3d4ee3c 100644 --- a/assets/highlight.css +++ b/assets/highlight.css @@ -1,22 +1,18 @@ :root { - --light-hl-0: #795E26; - --dark-hl-0: #DCDCAA; + --light-hl-0: #AF00DB; + --dark-hl-0: #C586C0; --light-hl-1: #000000; --dark-hl-1: #D4D4D4; - --light-hl-2: #A31515; - --dark-hl-2: #CE9178; - --light-hl-3: #AF00DB; - --dark-hl-3: #C586C0; - --light-hl-4: #001080; - --dark-hl-4: #9CDCFE; + --light-hl-2: #001080; + --dark-hl-2: #9CDCFE; + --light-hl-3: #A31515; + --dark-hl-3: #CE9178; + --light-hl-4: #795E26; + --dark-hl-4: #DCDCAA; --light-hl-5: #0000FF; --dark-hl-5: #569CD6; --light-hl-6: #0070C1; --dark-hl-6: #4FC1FF; - --light-hl-7: #0451A5; - --dark-hl-7: #9CDCFE; - --light-hl-8: #008000; - --dark-hl-8: #6A9955; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } @@ -29,8 +25,6 @@ --hl-4: var(--light-hl-4); --hl-5: var(--light-hl-5); --hl-6: var(--light-hl-6); - --hl-7: var(--light-hl-7); - --hl-8: var(--light-hl-8); --code-background: var(--light-code-background); } } @@ -42,8 +36,6 @@ --hl-4: var(--dark-hl-4); --hl-5: var(--dark-hl-5); --hl-6: var(--dark-hl-6); - --hl-7: var(--dark-hl-7); - --hl-8: var(--dark-hl-8); --code-background: var(--dark-code-background); } } @@ -55,8 +47,6 @@ --hl-4: var(--light-hl-4); --hl-5: var(--light-hl-5); --hl-6: var(--light-hl-6); - --hl-7: var(--light-hl-7); - --hl-8: var(--light-hl-8); --code-background: var(--light-code-background); } @@ -68,8 +58,6 @@ --hl-4: var(--dark-hl-4); --hl-5: var(--dark-hl-5); --hl-6: var(--dark-hl-6); - --hl-7: var(--dark-hl-7); - --hl-8: var(--dark-hl-8); --code-background: var(--dark-code-background); } @@ -80,6 +68,4 @@ .hl-4 { color: var(--hl-4); } .hl-5 { color: var(--hl-5); } .hl-6 { color: var(--hl-6); } -.hl-7 { color: var(--hl-7); } -.hl-8 { color: var(--hl-8); } pre, code { background: var(--code-background); } diff --git a/assets/navigation.js b/assets/navigation.js index 827f0fd..eb6ac1f 100644 --- a/assets/navigation.js +++ b/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA6WUTWvCQBCG/8uc04rSSsmtpUh7ajGCB+kh7E7N4mZjd1awiP+9KG4+3O0YyDG8L0+e7MxmdQCHewcpvC0Wn3P82SE5SGCbuwJSKCu500ijVnhfuFJDAhtlJKQPCYhCaWnRQLqqYR9bpypDDUgZh/Y7F1esS6/LnDxOj1/HpIa9G4l7lK8vM6Ux+yWHZWgYKQ02jTF7GWeusvkaOd+gMtg2JPZyXVZ2g3aWhYo+GWxWg3oJNR/wLAQSnZ4brNA5EdIo1upyx5OnG9Tr2XDs2JC6b4heII9shXdjjsIuu6dFSj2ppyWJnGY350jMantYUOHdLvV/zNopRwnX2BN8wlu0BnQ+jFu/rnMpssh/R+WFBlEFAAA=" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA43RMQvCMBAF4P9yc1GsKNJNkYKTQ0dxiMlpD9O0NIdUxP8uQrGNTUPn9/LxkpxewNgwJJCSxuxpGYutlGhtmkEEleAcEpBaWIt2PuzMci40RHAnoyBZxJt3NC6SxgkmaQypB6OwQbXfZVzWHs/NQ9K3IG444vTTSXuOFVNpbCeRYayvQvZHtSUXjFfr4awQ51ZC2P/rdtxD1CQu2vMDrreMfZf1Ob8wALTLfcfbaHD4/AF+P5O+pAIAAA==" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js index 445f528..cd1c44b 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7VcS5OcSA7+L/jK9JBPoG+zMzExc9mdWHt3Dx0OR3UVtgnXawvaHo/D/30jISkkkCChak9EN1J+yvwkpfJBfYsupy9V9Pj0LfpUHnfRo5BZHB03hyJ6jH4t98Xrr1VdHH7abouqcn9HcfRy2UeP0Xa/qaqi+pESevhYH/ZR3MlEj1H0Pe4QjJBXhO3pWNWXl219uoQ3/AprAZA4Om8uxbHmbO+NkInu+1l9PW4XwHvx23G3+1O1YEBfdfKrkOeIbf8Osqb9e5JkkUh9hfu7eyxs+JVXCu+r7wBjw8+XYlMvt+Kqdi87/nGuy9OxWmxIr3eDJcj7yuqnz5tyv3kODGpoDda9waJbkgE0aG1KmCbr3cfNcbcvlrMFFHtb6mr3Q1n9cL6Un1ufWkielUL3th2KerPb1JvFtgHFe7nSu+AMigZpcSKdtuJSHNckmqvavez4cinrIniuhKZAzXtZs20y2CpzkOq97KnqTb3YEq90LxuKP8uqXh7VV7V72XE6F8dVzADFe9nyctyXx0+LLbmq3S2KD7tyef7vtO5lxeHTGis6rftltM1u1Whc9e5lybH4sspRe737zYPQrg9F/Vsz1S62DGrezzZjr6b99ubNH/8s/vtSVPXvx13x59XC8lgXl/ebbVH9OJSZrqlBBQ8URz0H734QN1bp47amC3No17JKnECaKb5prOAalwAMKWtp1NA6lgANKV0DhvV8Kd6Xf/7rsg/BhMKrEd+VyK0n4K6SIYHG0BpY/RLoswVvgCMVh3P9NQSsE1yNdL4U+9NmR2ZbmkkgvhqVrMoIuMlCLADHFS4hOF5uNQ43cxJQc5NlIFooYUB2Nd47N3m9efPHH5v6Y1D8YfkbohBZcWnfh/Z8IP9/sOJ1+ddiS7zOemv05KR8OO1e9tiKySkZVhDDvSK6cHjwYkSzy/J5GVClILBX47TOQHZqHPTzpirg1BUC3uusggfFVFN6Fbtf/va6Pl3GDoRfT7MHPZMpdIjm5iqdgYHLyw4KM6TuYIERe7vnIMBGLCTOwlAr95IsWilwKH2TDXhZFAo/ucUUhrXdF5tAZr3kLWjPxYfy+OayOVabrYudIGBCaalfUWE5cTxByNy85uHbnF77UPYuWwNNIIdmiNv2/ScMCFkbTVuxOFmNjViUs0gjdJB7dbM2IXOP2ZtqNmgWX+Bi4/S4wAAmXc6YMjfLbzfbj7hGW2IS1L6bSeXu+deNc6evq2xC6jcZBfKey4mbDwVdjMCXdzlmHzUYFGTIxiWT4xhucmpkcPA+RNUKBWABUaIIONXFti52S/tJT8zEuE5OyyFIs5PyGDR4Sg7B/1CMNwnGkK3UepTzSwhKK7UeZVeMd8rGKK3UMt8ch/JEATOSuLl84VqcLl7Gli4rXVjUmcJlCje4bGHBQ4qWKQsWJtF1BcuUATrAlbpiZSRxj1Jl3GhQoRLsTsPcHQz9ikrlkybMTLv/OV0+FZdfX4/I7V7cHJmDhqYD8mrOsjgcYsyEH4ESHHVDqJBgI/BCY2wIFxJac4P47ksjMIvVy4XsHcyibl8uTvT3X+aBoehdsP3W5/j2wwgaSN4Fuax+P5Z1udmXfzVF1gz8UPwuNrDnRiN48tRoEXLokdUQeva8ai5o313O49tYY3rP2xv6FnDxaog4c9FqDoU8ohpiTJ5PzSGQh1NDhMmTqTkE5pLNEGPmUs0sH+QVmhEdk1dm5jDoCzIjV568EDPvV/Qh3tixpk/w5nCY62BDmJnrXwG92Z+pAzuiO53gOqT68nLchhQHQHA9Q+TxH0XR5KnnHBJ/qXIINX+Jcg5rcz4Xx7B+IdF1aNuPh9P8dNhJrcU4fZlPbZ3UytxWlwfiqvQot3Vi61CC8udN2bP6eggC6eXWx04QEBBc26Pj9mfyW5Nxn3rJYCzNL6G6pWn34h4r0mtbQQvRuYpwsACYw3lFLAQouH6t+Tb2B+uP36LPxaVye3CPkXxQD3kUR+/LYr9z3191u6Xb0+Hgmnrr3/27cAscJ9GK/JhE8VMSa/VgjXz7Nn7qNJoXzT8aMRHFTyKW9kElFokJJCaj+ElSrUkkpqL4SVFiConpKH7SlJhGYiaKn0ws0wdjMiRmkJiN4icby+whz3IkZpFYGsVPaaySB2uwWIrEsih+yiixDInl3LjleHjdaOdUV8WAh4aIJFbmQaQYWGAqhBtyIcg2MRvCjbqQscoejNZYEhMi3MALRUpiToQbe0GSJzAtwg2/MGSPMDPCMSAsiY7JEY4EkZLomB/REJSRbWKKpCNC5JSkxBxJR4RMSMlBuDTxIqi+S8yRdERIOrQwR9IRIcnokpgj6YiQJEcScyQdEdKQPcIcyZQLRokpkhkXjhIzJHMu0iQmSCVcrCnMj2r4sWT+wfyohh/Sj9Qgoyk2LhXmRzX8ZGSbmB/V8ENmBYX5UXwMKcyPciwo0jcVJkhlrG8qzJByPChBtokp0o4IRXqxxhxpR4QivVhjjrQjQtHTBOZIK9aL9WDi0dwkoDFF2vGgDAmOKdKOB0U6ncYU6YYi0uk0pkizMaQxQ5qdhjQmyDQEkc5pMEGmIYhMhwYTZCQ7P2N+jCNBk75pMD+mqQxIjzOD2sCxoMm5zWCCjGXNxPyYlBt1g+kxbI1gMD2GpcdgemzC9sZieqzgPNhidqxkebSYHtvQQ4akxfTYhh4yJC2mxzb0kPFjB9Wb5cbIYnosOwNZTI91JGgyIi3mx+asY1pMUJqwjpliglJHgyajPMUMpY4GTcZkihlKG4bICSPFDKWOBkP2KMUMpWx1nWKCUra+TgcFdsqFRYoJSjOO8hTzk+Z8bzA/WcKFRYbpyRwHhqyeM0xP1qQ3MiYzTE+muKHMMDuZ5oYyw+Rkhl2FYHIyNnoyTE7WRA8Z5NlgAeQ4MGSQZ5ierKGHDPIM05M7EgwZkjnmJ2/4IcMnx/zkkq3McsxP3vBDBlqOCco1u2LKMUO5YSuzHFOUW7YyyzFHecquWXLMUZ6xa5Z8sE7N2TVLPlyqJmxh2L6DsoJfsiWD9WrSBBKzCB6sWBPHhyX3Ldp3UFaz5Wn7DsoafoGbDNatSZPw6AV2Mli5Jk3NQBa+7Tso21R1ZAi276Cs48bSy+xkwFuzk2DJMBSjXQbHjSUDUQz3GZrdBEsvtoc7Dc1+giVDTAz3GpodBTqxiuFuQ7OnQOZ1MdxuaDYVLO1mfsOh2WP7XFzqYtd+aut2y7qj83IXxd+6jxUfzXXr71uUZdHjt+/f+00395dr330v9bGuz+0pTK+sZK+sE075+tsfvWLe6wlWz39N02vJtFdTklWrSnhODrpqe/WcRe1Pm4EmAM4Fp+nvB7xvDj/AICkwSCHKVXOnFzQAKNJst/vbCcBuA8jNWU138A2UMtBZxSldbxv1ihqMr2Vdqf2Rk15LCOALbO+6bWZgJhjWLGX02uOoISMWQiaW0XXfU7lNcMgE6KFm9dwN0xreMAVDBJCNdipxlHKu2FzwHjqDBt22HDv+cAz0WMIec6Plz7uAmoJqHKX+Hi+wMQG9VG0vLed+/ke8wCCDIOd04FUn4ErA2hY1bx8qaZ/a/23801pPQdY+M47Trb81BoYG0NAqS9+I9k+T+sb9+0xPNj50UgGiXhhG1X1CBkYORK7hvKq5wQu4Aqk45cbbf8QNMjFAUly/uvsBoE9g1IQfHldG0fpNLmxuKm6aX5gYjhDwMq6zVBOVvy0KxgBENdNQc4cbaIAJIeXsd5Om/0UNMHLAvSWH5ubaS/fhLNAF6Vx6r9IcZ6CN8UQKeiw53yp3z++7bzlAz4Gq5ewfASpguWYB2y9Dds8MSyCHGeMDmCP+2lbVfjUCTAHUaS4TltWmv7rZ6wKv90Euu4zi/069V2dcJ9uDa5BHwMgIthaiihKRQE2f6Hy2zbmJ1F9AAq4AWpFd1uRydSMI52DAiB8P338j/dO7qe2SoZfLOLc9Fl+GcS4B8ZLTa6+hAZpBv5QHz7n07pRH+Rf4ieCmvlN3LN/rwczgQ9RP9NYPb+ZnI8Gm9fbnSAbFhwTJU3E5x//8xWgIQZZXLOoLznHA21POn65XzQAWmIaldwOVdcme83DX0KhyBi2pvGuBSzr9tRAQXZBEtrrsL5gB10ZLFF5zGBICVlpdNLImHwZjJwCq9G6Sc87X3u0EyjCV+LhT/plzpBN1vAHDnnGO5vXoVG1A8KVdmcslFd/SKFFr0B07Zf6IAwVG0figsxyF12tLwGtgmSLYERgsZGCWmlAZ1bs2g2hcfuuvJgJNOAMknGZ3eRY4CkT0cZVzU2F3Pw3Awso04Wgdr9gsDCnB5eJW7z1ex4KxzWSXPbmoai48jtI5XMroLpeQbvU2js7ludiXxyJ6fHr7/fv/AAkWSdYVWgAA"; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7WaTW/jNhCG/wtz1XrND3/eWhSL7qU9uOhFCBaKxCRCbNmQlGxTI/+9ICVZM/aMQ0XpKZtohu8Mn+GIFPcoyv3PSqzjo3jKi0yspVpGokh2VqzFt3xrN69VbXe/pKmtKve7iMRzuRVrkW6TqrLVV8po8ljvtiLqbMRaiLeoU5hJdVJI90VVl89pvS/DB77BXkAkEoektEXNxd4Hoaamz7N6LdLNa5EOCAG4fI7+QO1P0U23+2oA0JvO/pOUB0459PlQBFdLe/N+JJv/p6w3I4p6A9ObKnOK4MdjUmRbWwXLA4deu66yL3n15VDmL0ltgyNBqEubZK/BYXTWH8gfqe5snWRJnQQLA4ex2mHLefORxXxllv0/wqe5NR+r+7PMaxv2XmilocdY9bS0yUB55DKadJ3U4aQb47Ga+4MtBmUMHMZqPxfbvHgKVj6Zj9UdpPpJmuUuy8O7d2c9um89DVHtrMd3jyQblO3Jfqzyg61/9y+eYG3oQbyp9rVNa5sFR6MVuyc4hfSSlHlytyWCurojgPuN70Vm/7HZb79u6n15mSx+fHVUogGGDHdzMqWRnQU4fF9DagbsaVhhtJ/J7oIEvVlYVYTpVu7hH9SrlZKH1iOjUHMlTR8H+XanQrj6XufV8ObcJoF8W8sxanf2IS/+KpOiStI63xdBwoTT0Bhm88vF+efBDdYv/LyobXmfpDCK1ub6yr9eQu8Ny9QRmVcXMiOeJumj3eT/DhCHLuPE8+zuW+IW/2u4OvIZLA+6+cmKaOOnZ8H925VP8mDp7g0ffsoZ8WLAoE6KYhzWSS4Fr/YRRgmfQKvGKEALmIZ1TS7T97sYMbNXe1iI0rsd7FI0uH+F6D/Yy0PIpWRj9XGVw3OISmP1cZXS7vYvITVzMhymBbp+a3Kl52OLYR0fVv71IW+o6idyudrtNmeSfa9rn1DR30Yid51QrI/ixZaVK8S1UBM9WYlI3Od2m7lPw13LSPe7nYvotn32t3XtyFk0Jl+nIoqnkZ5NpvP57W0Udx7+gf+DN5MiimWkzGS6WCEzicyUiGJFjaaQmRZRrCO1mqxmC2SmkZkRUWyo0Qwym4konlFmM2Q2F1E8p8zmyGzBZbpAZksRxQtqtCUyW4koXlJmKzy9brZXlJ084yC5qZOYhHQzLkmyEsOQbtKlJC0xD+nmXZJ8JUYi3dRLTVpiKtLNviQpSwxGejIkaInZSMdAkqwlxiMdBklylJiQchwkiVJhRMqvFRKmOlstfrmQjBRmpBwIRTJSmJFyIBS9BjEj5UAokpHCjNScWxMKI1KOgyJhKoxIOQ5qRhWywoiU46DmpCVGpB0HtSD7CkakHQe1JC0xIu0RkTD1WU/TbEYaI9KOgyaxa4xIOw6axK4xIu1AaBK7xoy0A6FJ7Boz0ksOu8aINI9IY0TGcdB0T8eIjGRhGozIKBamwYiMf++QHcScvXk8IrKDGIzIeERkBzEYkfGIyA5iMCLjEa3IjDAis+QtG0Z+v/Biy9pm35t9QxyDm6aj+NFuJxbdvuQolmJ9fHvrNw/uNzd0v+fv3bTp/cyUcfRb5xpunfsB+gPbUWjpXCJhFDOQP+dW/pwLQpiCEQzn2RwZgC5IWE9bXcl6+1vU3htmfc2nuSrq/Wa934zzg8fG3lP2nu0sLZofat781By27isiyF33gyk2Du92728hQBgKxMGl7j7pATUwWWrBuDidyn+lTdoPuWAAkLvSgQOcBw6KhCvTiyFQFPN+gDkzgD+vgcIEtA0X94OtH9tv4yBjEK3iFkOe3d13n12AKJgszbHNm48pmJMGaDWX4slz353BQNQrMAAbdTdA1XyXAe5AX3Gl1dwUgXoEWCS3AvqL4t4RxCq5gmjvaoAaaFaK82qOXiAvEKJatYt1xTi7m7+LNQcWkOTA+FM8gAlEDTeZpzshoAXmRXHtsL3x773AtHCJdYd/ECLowIar1O7WG0QI1obkqqy92wNeQExyMTbXvcAJ9EnJRUi9FMEkmrZNG644W39iPWkwrYbj3rpfrCYNYtdc1/VeF/UK2pZatvXKta/zFxxUbVwlV0XO9dwdtgDGrbuhBphAwJJL1f8fhouVBd+qZIq3kTjkB7vNCyvW8e3b238Ey3EHficAAA=="; \ No newline at end of file diff --git a/classes/FileSystemAccessFS.html b/classes/FileSystemAccessFS.html new file mode 100644 index 0000000..5a27a05 --- /dev/null +++ b/classes/FileSystemAccessFS.html @@ -0,0 +1,557 @@ +FileSystemAccessFS | BrowserFS DOM
+
+ +
+
+
+
+ +

Class FileSystemAccessFS

+
+

Hierarchy

+
    +
  • AsyncFileSystem<this> & FileSystem<this> +
      +
    • FileSystemAccessFS
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
_handles: Map<string, FileSystemHandle> = ...
+
+

Methods

+
+ +
+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      path: string
    • +
    • +
      flag: FileFlag
    • +
    • +
      mode: number
    • +
    • +
      cred: Cred
    +

    Returns File

+
+ +
    + +
  • +

    Test whether or not the given path exists by checking with the file system.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
    • +
    • +
      cred: Cred
    +

    Returns Promise<boolean>

    +
+
+ +
    + +
  • +

    Test whether or not the given path exists by checking with the file system.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
    • +
    • +
      cred: Cred
    +

    Returns boolean

    +
+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      path: string
    +

    Returns Promise<FileSystemHandle>

+
+ +
+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      srcpath: string
    • +
    • +
      dstpath: string
    • +
    • +
      cred: Cred
    +

    Returns void

+
+ +
    + +
  • +

    Returns FileSystemMetadata

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      path: string
    +

    Returns Promise<void>

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      path: string
    • +
    • +
      mode: number
    • +
    • +
      cred: Cred
    +

    Returns void

+
+ +
+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      path: string
    • +
    • +
      flag: FileFlag
    • +
    • +
      cred: Cred
    +

    Returns File

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      path: string
    +

    Returns Promise<string[]>

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      path: string
    • +
    • +
      cred: Cred
    +

    Returns string[]

+
+ +
+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      oldPath: string
    • +
    • +
      newPath: string
    +

    Returns Promise<void>

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      oldPath: string
    • +
    • +
      newPath: string
    • +
    • +
      cred: Cred
    +

    Returns void

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      path: string
    +

    Returns Promise<void>

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      path: string
    • +
    • +
      cred: Cred
    +

    Returns void

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      path: string
    +

    Returns Promise<Stats>

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      path: string
    • +
    • +
      cred: Cred
    +

    Returns Stats

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      p: string
    • +
    • +
      data: Uint8Array
    • +
    • +
      stats: Stats
    +

    Returns Promise<void>

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      path: string
    • +
    • +
      data: Uint8Array
    • +
    • +
      stats: Readonly<Stats>
    +

    Returns void

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      path: string
    +

    Returns Promise<void>

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      path: string
    • +
    • +
      cred: Cred
    +

    Returns void

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      fname: string
    • +
    • +
      data: Uint8Array
    +

    Returns Promise<void>

+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/classes/FileSystemAccessFile.html b/classes/FileSystemAccessFile.html index 50d9d15..a42696f 100644 --- a/classes/FileSystemAccessFile.html +++ b/classes/FileSystemAccessFile.html @@ -18,11 +18,11 @@

Class FileSystemAccessFile

Hierarchy

+
  • Defined in src/FileSystemAccess.ts:29
  • @@ -36,37 +36,37 @@

    Constructors

    Properties

    +
    +

    Accessors

    +

    Methods

    -
    advancePos +

    Returns FileSystemAccessFile

    +
  • Defined in src/FileSystemAccess.ts:30
  • Properties

    @@ -105,62 +105,129 @@
    +
  • Defined in node_modules/@browserfs/core/dist/file.d.ts:272
  • _dirty: boolean
    -
    - -
    _flag: FileFlag
    -
    - -
    -
    - -
    _path: string
    -
    - -
    _pos: number
    -
    - -
    _stat: Stats
    +
  • Defined in node_modules/@browserfs/core/dist/file.d.ts:274
  • +
    + +
    _position: number
    +
    + +
    flag: FileFlag
    +
    + + +

    The file system that created the file.

    +
    +
    +
    + +
    path: string
    +

    Path to the file

    +
    +
    +
    + +
    stats: Stats
    -

    Methods

    -
    - +

    Accessors

    +
    +
      - +
    • get buffer(): Uint8Array
    • -

      Advance the current file position by the indicated number of positions.

      +

      Get the underlying buffer for this file. Mutating not recommended and will mess up dirty tracking.

      +
      +

      Returns Uint8Array

      +
    +
    + +
      +
    • get position(): number
    • +
    • +

      Get the current file position.

      +

      We emulate the following bug mentioned in the Node documentation:

      +
      +

      On Linux, positional writes don't work when the file is opened in append + mode. The kernel ignores the position argument and always appends the data + to the end of the file.

      +
      +
      +

      Returns number

      The current file position.

      + +
    • +
    • set position(newPos): void
    • +
    • +

      Set the file position.

      Parameters

      • -
        delta: number
      -

      Returns number

      +
      newPos: number
      +

      new position

      +
      +
    +

    Returns void

    +
  • Defined in node_modules/@browserfs/core/dist/file.d.ts:314
  • +
    +

    Methods

    +
    + +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        type: FileType
      +

      Returns Promise<void>

    +
    + +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        type: FileType
      +

      Returns void

    Returns Promise<void>

    +
  • Defined in node_modules/@browserfs/core/dist/file.d.ts:391
  • Returns void

    +
  • Defined in node_modules/@browserfs/core/dist/file.d.ts:396
  • Returns Promise<void>

    +
  • Defined in node_modules/@browserfs/core/dist/file.d.ts:402
  • Returns void

    +
  • Defined in node_modules/@browserfs/core/dist/file.d.ts:408
  • -
    +
  • Defined in src/FileSystemAccess.ts:45
  • +
    -
    +
  • Defined in src/FileSystemAccess.ts:49
  • +
  • Defined in node_modules/@browserfs/core/dist/file.d.ts:210
  • -
    - -
    -
    - -
    -
    - -
    -
    - -
    -
    - -
    +
  • Defined in node_modules/@browserfs/core/dist/file.d.ts:216
  • +
  • Defined in node_modules/@browserfs/core/dist/file.d.ts:411
    • - +
    • Read data from the file.

      +
      +

      Type Parameters

      +
        +
      • +

        TBuffer extends Uint8Array

      Parameters

      • -
        buffer: Uint8Array
      • +
        buffer: TBuffer
        +

        The buffer that the data will be + written to.

        +
        +
      • -
        offset: number
      • +
        Optional offset: number
        +

        The offset within the buffer where writing will + start.

        +
        +
      • -
        length: number
      • +
        Optional length: number
        +

        An integer specifying the number of bytes to read.

        +
        +
      • -
        position: number
      -

      Returns Promise<{
          buffer: Uint8Array;
          bytesRead: number;
      }>

      +
      Optional position: number
      +

      An integer specifying where to begin reading from + in the file. If position is null, data will be read from the current file + position.

      +
      +
    +

    Returns Promise<{
        buffer: TBuffer;
        bytesRead: number;
    }>

    +
  • Defined in node_modules/@browserfs/core/dist/file.d.ts:371
  • +

    Returns number

    number of bytes written

    +
  • Defined in node_modules/@browserfs/core/dist/file.d.ts:386
    • @@ -404,24 +455,7 @@

      Returns void

    -
    - -
      - -
    • -

      Set the file position.

      -
      -
      -

      Parameters

      -
        -
      • -
        newPos: number
      -

      Returns number

      -
    +
  • Defined in node_modules/@browserfs/core/dist/file.d.ts:415
    • @@ -433,7 +467,7 @@

      Returns Promise<

    +
  • Defined in node_modules/@browserfs/core/dist/file.d.ts:318
    • @@ -445,7 +479,7 @@

      Returns Stats

    +
  • Defined in node_modules/@browserfs/core/dist/file.d.ts:322
  • -
    +
  • Defined in src/FileSystemAccess.ts:38
  • +
    -
      +
      • -

        Core: Synchronous sync.

        -
        -

        Returns void

        -
    +
  • Defined in src/FileSystemAccess.ts:34
  • Returns Promise<void>

    +
  • Defined in node_modules/@browserfs/core/dist/file.d.ts:327
  • Returns void

    +
  • Defined in node_modules/@browserfs/core/dist/file.d.ts:332
    • @@ -516,7 +549,7 @@
      mtime: Returns Promise<void>
    +
  • Defined in node_modules/@browserfs/core/dist/file.d.ts:409
    • @@ -532,11 +565,11 @@
      mtime: Returns void
    +
  • Defined in node_modules/@browserfs/core/dist/file.d.ts:410
  • Returns Promise<number>

    +
  • Defined in node_modules/@browserfs/core/dist/file.d.ts:345
  • +

    Returns number

    bytes written

    +
  • Defined in node_modules/@browserfs/core/dist/file.d.ts:359
  • +
  • IndexedDBOptions
  • +
  • StorageOptions
  • +
  • FileSystemAccess
  • +
  • IndexedDB
  • +
  • Storage
  • Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/FileSystemAccessFileSystem.html b/classes/FileSystemAccessFileSystem.html deleted file mode 100644 index 7713efa..0000000 --- a/classes/FileSystemAccessFileSystem.html +++ /dev/null @@ -1,1136 +0,0 @@ -FileSystemAccessFileSystem | BrowserFS DOM
    -
    - -
    -
    -
    -
    - -

    Class FileSystemAccessFileSystem

    -
    -

    Hierarchy

    -
      -
    • BaseFileSystem -
        -
      • FileSystemAccessFileSystem
    -
    -
    -
    - -
    -
    -

    Constructors

    -
    - -
    -
    -

    Properties

    -
    - -
    _handles: Map<string, FileSystemHandle> = ...
    -
    - -
    -
    - -
    Create: any = ...
    -
    - -
    Name: "FileSystemAccess" = 'FileSystemAccess'
    -
    - -
    Options: BackendOptions = {}
    -
    -

    Accessors

    -
    - -
    -
    -

    Methods

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        p: string
      • -
      • -
        data: Uint8Array
      • -
      • -
        stats: Stats
      • -
      • -
        cred: Cred
      -

      Returns Promise<void>

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        p: string
      • -
      • -
        mode: number
      • -
      • -
        cred: Cred
      -

      Returns Promise<void>

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        p: string
      • -
      • -
        mode: number
      • -
      • -
        cred: Cred
      -

      Returns void

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        fname: string
      • -
      • -
        data: Uint8Array
      • -
      • -
        flag: FileFlag
      • -
      • -
        mode: number
      • -
      • -
        cred: Cred
      -

      Returns Promise<void>

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        fname: string
      • -
      • -
        data: Uint8Array
      • -
      • -
        flag: FileFlag
      • -
      • -
        mode: number
      • -
      • -
        cred: Cred
      -

      Returns void

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        p: string
      • -
      • -
        mode: number
      • -
      • -
        cred: Cred
      -

      Returns Promise<void>

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        p: string
      • -
      • -
        mode: number
      • -
      • -
        cred: Cred
      -

      Returns void

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        p: string
      • -
      • -
        new_uid: number
      • -
      • -
        new_gid: number
      • -
      • -
        cred: Cred
      -

      Returns Promise<void>

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        p: string
      • -
      • -
        new_uid: number
      • -
      • -
        new_gid: number
      • -
      • -
        cred: Cred
      -

      Returns void

    -
    - -
    -
    - -
      - -
    • -

      Create the file at path p with the given mode. Then, open it with the given -flag.

      -
      -
      -

      Parameters

      -
        -
      • -
        p: string
      • -
      • -
        flag: FileFlag
      • -
      • -
        mode: number
      • -
      • -
        cred: Cred
      -

      Returns File

      -
    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        p: string
      • -
      • -
        cred: Cred
      -

      Returns Promise<boolean>

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        p: string
      • -
      • -
        cred: Cred
      -

      Returns boolean

    -
    - -
    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        srcpath: string
      • -
      • -
        dstpath: string
      • -
      • -
        cred: Cred
      -

      Returns Promise<void>

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        srcpath: string
      • -
      • -
        dstpath: string
      • -
      • -
        cred: Cred
      -

      Returns void

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        p: string
      • -
      • -
        mode: any
      • -
      • -
        cred: Cred
      -

      Returns Promise<void>

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        p: string
      • -
      • -
        mode: number
      • -
      • -
        cred: Cred
      -

      Returns void

    -
    - -
    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        p: string
      • -
      • -
        flag: FileFlag
      • -
      • -
        mode: number
      • -
      • -
        cred: Cred
      -

      Returns Promise<File>

    -
    - -
    -
    - -
      - -
    • -

      Opens the file at path p with the given flag. The file must exist.

      -
      -
      -

      Parameters

      -
        -
      • -
        p: string
        -

        The path to open.

        -
        -
      • -
      • -
        flag: FileFlag
        -

        The flag to use when opening the file.

        -
        -
      • -
      • -
        cred: Cred
      -

      Returns File

      A File object corresponding to the opened file.

      - -
    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        p: string
      • -
      • -
        flag: FileFlag
      • -
      • -
        mode: number
      • -
      • -
        cred: Cred
      -

      Returns File

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        fname: string
      • -
      • -
        flag: FileFlag
      • -
      • -
        cred: Cred
      -

      Returns Promise<Uint8Array>

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        fname: string
      • -
      • -
        flag: FileFlag
      • -
      • -
        cred: Cred
      -

      Returns Uint8Array

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        path: string
      • -
      • -
        cred: Cred
      -

      Returns Promise<string[]>

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        p: string
      • -
      • -
        cred: Cred
      -

      Returns string[]

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        p: string
      • -
      • -
        cred: Cred
      -

      Returns Promise<string>

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        p: string
      • -
      • -
        cred: Cred
      -

      Returns string

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        p: string
      • -
      • -
        cred: Cred
      -

      Returns Promise<string>

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        p: string
      • -
      • -
        cred: Cred
      -

      Returns string

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        oldPath: string
      • -
      • -
        newPath: string
      • -
      • -
        cred: Cred
      -

      Returns Promise<void>

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        oldPath: string
      • -
      • -
        newPath: string
      • -
      • -
        cred: Cred
      -

      Returns void

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        path: string
      • -
      • -
        cred: Cred
      -

      Returns Promise<void>

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        p: string
      • -
      • -
        cred: Cred
      -

      Returns void

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        path: string
      • -
      • -
        cred: Cred
      -

      Returns Promise<Stats>

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        p: string
      • -
      • -
        cred: Cred
      -

      Returns Stats

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        srcpath: string
      • -
      • -
        dstpath: string
      • -
      • -
        type: string
      • -
      • -
        cred: Cred
      -

      Returns Promise<void>

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        srcpath: string
      • -
      • -
        dstpath: string
      • -
      • -
        type: string
      • -
      • -
        cred: Cred
      -

      Returns void

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        p: string
      • -
      • -
        len: number
      • -
      • -
        cred: Cred
      -

      Returns Promise<void>

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        p: string
      • -
      • -
        len: number
      • -
      • -
        cred: Cred
      -

      Returns void

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        path: string
      • -
      • -
        cred: Cred
      -

      Returns Promise<void>

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        p: string
      • -
      • -
        cred: Cred
      -

      Returns void

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        p: string
      • -
      • -
        atime: Date
      • -
      • -
        mtime: Date
      • -
      • -
        cred: Cred
      -

      Returns Promise<void>

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        p: string
      • -
      • -
        atime: Date
      • -
      • -
        mtime: Date
      • -
      • -
        cred: Cred
      -

      Returns void

    -
    - -
    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        fname: string
      • -
      • -
        data: Uint8Array
      • -
      • -
        flag: FileFlag
      • -
      • -
        mode: number
      • -
      • -
        cred: Cred
      • -
      • -
        Optional createFile: boolean
      -

      Returns Promise<void>

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        fname: string
      • -
      • -
        data: Uint8Array
      • -
      • -
        flag: FileFlag
      • -
      • -
        mode: number
      • -
      • -
        cred: Cred
      -

      Returns void

    -
    - -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file diff --git a/classes/HTTPRequest-1.html b/classes/HTTPRequest-1.html deleted file mode 100644 index 6dfc40f..0000000 --- a/classes/HTTPRequest-1.html +++ /dev/null @@ -1,1217 +0,0 @@ -HTTPRequest | BrowserFS DOM
    -
    - -
    -
    -
    -
    - -

    Class HTTPRequest

    -
    -

    A simple filesystem backed by HTTP downloads. You must create a directory listing using the -make_http_index tool provided by BrowserFS.

    -

    If you install BrowserFS globally with npm i -g browserfs, you can generate a listing by -running make_http_index in your terminal in the directory you would like to index:

    -
    make_http_index > index.json
    -
    -

    Listings objects look like the following:

    -
    {
    "home": {
    "jvilk": {
    "someFile.txt": null,
    "someDir": {
    // Empty directory
    }
    }
    }
    } -
    -

    This example has the folder /home/jvilk with subfile someFile.txt and subfolder someDir.

    -
    -
    -
    -

    Hierarchy

    -
      -
    • BaseFileSystem -
        -
      • HTTPRequest
    -
    -
    -
    - -
    -
    -

    Constructors

    -
    - -
    -
    -

    Properties

    -
    - -
    _index: FileIndex<{}>
    -
    -

    Type declaration

    -
      -
      - -
      _ready: Promise<HTTPRequest>
      -
      - -
      prefixUrl: string
      -
      - -
      Create: any = ...
      -
      - -
      Name: "HTTPRequest" = 'HTTPRequest'
      -
      -

      Accessors

      -
      - -
      -
      -

      Methods

      -
      - -
      -
      - -
        - -
      • -

        Asynchronously download the given file.

        -
        -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          type: "buffer"
        -

        Returns Promise<Uint8Array>

        -
      • - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          type: "json"
        -

        Returns Promise<any>

      • - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          type: "buffer" | "json"
        -

        Returns Promise<any>

      -
      - -
        - -
      • -

        Only requests the HEAD content, for the file size.

        -
        -
        -

        Parameters

        -
          -
        • -
          path: string
        -

        Returns Promise<number>

        -
      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          fname: string
        • -
        • -
          data: Uint8Array
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          fname: string
        • -
        • -
          data: Uint8Array
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          new_uid: number
        • -
        • -
          new_gid: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          new_uid: number
        • -
        • -
          new_gid: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -

        Create the file at path p with the given mode. Then, open it with the given -flag.

        -
        -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<File>

        -
      -
      - -
        - -
      • -

        Create the file at path p with the given mode. Then, open it with the given -flag.

        -
        -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns File

        -
      -
      - -
      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<boolean>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns boolean

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          srcpath: string
        • -
        • -
          dstpath: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          srcpath: string
        • -
        • -
          dstpath: string
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          path: string
        • -
        • -
          flags: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<NoSyncFile<HTTPRequest>>

      -
      - -
        - -
      • -

        Opens the file at path p with the given flag. The file must exist.

        -
        -
        -

        Parameters

        -
          -
        • -
          p: string
          -

          The path to open.

          -
          -
        • -
        • -
          flag: FileFlag
          -

          The flag to use when opening the file.

          -
          -
        • -
        • -
          cred: Cred
        -

        Returns Promise<File>

        -
      -
      - -
        - -
      • -

        Opens the file at path p with the given flag. The file must exist.

        -
        -
        -

        Parameters

        -
          -
        • -
          p: string
          -

          The path to open.

          -
          -
        • -
        • -
          flag: FileFlag
          -

          The flag to use when opening the file.

          -
          -
        • -
        • -
          cred: Cred
        -

        Returns File

        A File object corresponding to the opened file.

        - -
      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns File

      -
      - -
        - -
      • -

        Special HTTPFS function: Preload the given file into the index.

        -
        -
        -

        Parameters

        -
          -
        • -
          path: string
          -
        • -
        • -
          buffer: Uint8Array
          -
        -

        Returns void

        -
      -
      - -
        - -
      • -

        We have the entire file as a buffer; optimize readFile.

        -
        -
        -

        Parameters

        -
          -
        • -
          fname: string
        • -
        • -
          flag: FileFlag
        • -
        • -
          cred: Cred
        -

        Returns Promise<Uint8Array>

        -
      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          fname: string
        • -
        • -
          flag: FileFlag
        • -
        • -
          cred: Cred
        -

        Returns Uint8Array

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          path: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<string[]>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns string[]

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<string>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns string

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<string>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns string

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          oldPath: string
        • -
        • -
          newPath: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          oldPath: string
        • -
        • -
          newPath: string
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          path: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<Stats>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Stats

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          srcpath: string
        • -
        • -
          dstpath: string
        • -
        • -
          type: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          srcpath: string
        • -
        • -
          dstpath: string
        • -
        • -
          type: string
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          len: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          len: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          atime: Date
        • -
        • -
          mtime: Date
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          atime: Date
        • -
        • -
          mtime: Date
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -

        Returns Promise<HTTPRequest>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          fname: string
        • -
        • -
          data: Uint8Array
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          fname: string
        • -
        • -
          data: Uint8Array
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
      -
      -
      -

      Generated using TypeDoc

      -
      \ No newline at end of file diff --git a/classes/IndexedDBFileSystem-1.html b/classes/IndexedDBFileSystem-1.html deleted file mode 100644 index bf8f7fb..0000000 --- a/classes/IndexedDBFileSystem-1.html +++ /dev/null @@ -1,1192 +0,0 @@ -IndexedDBFileSystem | BrowserFS DOM
      -
      - -
      -
      -
      -
      - -

      Class IndexedDBFileSystem

      -
      -

      A file system that uses the IndexedDB key value file system.

      -
      -
      -
      -

      Hierarchy

      -
        -
      • AsyncKeyValueFileSystem -
          -
        • IndexedDBFileSystem
      -
      -
      -
      - -
      -
      -

      Constructors

      -
      - -
      -
      -

      Properties

      -
      - -
      _ready: Promise<IndexedDBFileSystem>
      -
      - -
      store: AsyncKeyValueStore
      -
      - -
      Create: any = ...
      -
      - -
      Name: "IndexedDB" = 'IndexedDB'
      -
      -

      Accessors

      -
      - -
        -
      • get metadata(): FileSystemMetadata
      • -
      • -

        Returns FileSystemMetadata

      -
      -

      Methods

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          data: Uint8Array
        • -
        • -
          stats: Stats
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          fname: string
        • -
        • -
          data: Uint8Array
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          fname: string
        • -
        • -
          data: Uint8Array
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          new_uid: number
        • -
        • -
          new_gid: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          new_uid: number
        • -
        • -
          new_gid: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<File>

      -
      - -
        - -
      • -

        Create the file at path p with the given mode. Then, open it with the given -flag.

        -
        -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns File

        -
      -
      - -
        - -
      • -

        Delete all contents stored in the file system.

        -
        -

        Returns Promise<void>

        -
      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<boolean>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns boolean

      -
      - -
        - -
      • -

        Returns string

      -
      - -
        - -
      • -

        Initializes the file system. Typically called by subclasses' async -constructors.

        -
        -
        -

        Parameters

        -
          -
        • -
          store: AsyncKeyValueStore
        -

        Returns Promise<void>

        -
      -
      - -
        - -
      • -

        Returns boolean

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          srcpath: string
        • -
        • -
          dstpath: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          srcpath: string
        • -
        • -
          dstpath: string
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<File>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          flag: FileFlag
        • -
        • -
          cred: Cred
        -

        Returns Promise<File>

      -
      - -
        - -
      • -

        Opens the file at path p with the given flag. The file must exist.

        -
        -
        -

        Parameters

        -
          -
        • -
          p: string
          -

          The path to open.

          -
          -
        • -
        • -
          flag: FileFlag
          -

          The flag to use when opening the file.

          -
          -
        • -
        • -
          cred: Cred
        -

        Returns File

        A File object corresponding to the opened file.

        - -
      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns File

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          fname: string
        • -
        • -
          flag: FileFlag
        • -
        • -
          cred: Cred
        -

        Returns Promise<Uint8Array>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          fname: string
        • -
        • -
          flag: FileFlag
        • -
        • -
          cred: Cred
        -

        Returns Uint8Array

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<string[]>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns string[]

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<string>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns string

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<string>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns string

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          oldPath: string
        • -
        • -
          newPath: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

        -
        -

        Todo

        Make rename compatible with the cache.

        -
      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          oldPath: string
        • -
        • -
          newPath: string
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<Stats>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Stats

      -
      - -
        - -
      • -

        Returns boolean

      -
      - -
        - -
      • -

        Returns boolean

      -
      - -
        - -
      • -

        Returns boolean

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          srcpath: string
        • -
        • -
          dstpath: string
        • -
        • -
          type: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          srcpath: string
        • -
        • -
          dstpath: string
        • -
        • -
          type: string
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          len: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          len: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          atime: Date
        • -
        • -
          mtime: Date
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          atime: Date
        • -
        • -
          mtime: Date
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -

        Returns Promise<IndexedDBFileSystem>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          fname: string
        • -
        • -
          data: Uint8Array
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          fname: string
        • -
        • -
          data: Uint8Array
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          idbFactory: IDBFactory = globalThis.indexedDB
        -

        Returns boolean

      -
      -
      -

      Generated using TypeDoc

      -
      \ No newline at end of file diff --git a/classes/IndexedDBStore.html b/classes/IndexedDBStore.html index 38ee9d7..257e35c 100644 --- a/classes/IndexedDBStore.html +++ b/classes/IndexedDBStore.html @@ -22,9 +22,9 @@

      Hierarchy

      Implements

        -
      • AsyncKeyValueStore
      @@ -36,15 +36,18 @@

      Constructors

      Properties

      -
      +
      +

      Accessors

      +

      Methods

      Constructors

      @@ -62,68 +65,70 @@
      db: storeName: string

      Returns IndexedDBStore

      +
    • Defined in src/IndexedDB.ts:132
    • Properties

      -
      - +
      +
      db: IDBDatabase
      -
      - +
    • Defined in src/IndexedDB.ts:132
    • +
      +
      storeName: string
      +
    • Defined in src/IndexedDB.ts:132
    • +
      +

      Accessors

      +
      + +
        +
      • get name(): string
      • +
      • +

        Returns string

      Methods

        - +
      • Parameters

        • type: "readonly"
        -

        Returns AsyncKeyValueROTransaction

      • - +
      • Defined in src/IndexedDB.ts:153
      +
    • Parameters

      • type: "readwrite"
      -

      Returns AsyncKeyValueRWTransaction

    • +
    • Defined in src/IndexedDB.ts:154
    • -
      - -
        - -
      • -

        Returns string

      -
      - +
    • Defined in src/IndexedDB.ts:138
    • +
      +
        - +
      • Parameters

        @@ -134,7 +139,7 @@
        storeName: indexedDB: IDBFactory

      Returns Promise<IndexedDBStore>

      +
    • Defined in src/IndexedDB.ts:110
    • +
    • IndexedDBOptions
    • +
    • StorageOptions
    • +
    • FileSystemAccess
    • +
    • IndexedDB
    • +
    • Storage
    • Generated using TypeDoc

      \ No newline at end of file diff --git a/classes/StorageFileSystem-1.html b/classes/StorageFileSystem-1.html deleted file mode 100644 index 96e8953..0000000 --- a/classes/StorageFileSystem-1.html +++ /dev/null @@ -1,1163 +0,0 @@ -StorageFileSystem | BrowserFS DOM
      -
      - -
      -
      -
      -
      - -

      Class StorageFileSystem

      -
      -

      A synchronous file system backed by a Storage (e.g. localStorage).

      -
      -
      -
      -

      Hierarchy

      -
        -
      • SyncKeyValueFileSystem -
          -
        • StorageFileSystem
      -
      -
      -
      - -
      -
      -

      Constructors

      -
      - -
      -
      -

      Properties

      -
      - -
      _ready: Promise<StorageFileSystem>
      -
      - -
      Create: any = ...
      -
      - -
      Name: "Storage" = 'Storage'
      -
      -

      Accessors

      -
      - -
        -
      • get metadata(): FileSystemMetadata
      • -
      • -

        Returns FileSystemMetadata

      -
      -

      Methods

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          data: Uint8Array
        • -
        • -
          stats: Stats
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          fname: string
        • -
        • -
          data: Uint8Array
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          fname: string
        • -
        • -
          data: Uint8Array
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          new_uid: number
        • -
        • -
          new_gid: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          new_uid: number
        • -
        • -
          new_gid: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -

        Create the file at path p with the given mode. Then, open it with the given -flag.

        -
        -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<File>

        -
      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns SyncKeyValueFile

      -
      - -
        - -
      • -

        Delete all contents stored in the file system.

        -
        -

        Returns void

        -
      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<boolean>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns boolean

      -
      - -
        - -
      • -

        Returns string

      -
      - -
        - -
      • -

        Returns boolean

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          srcpath: string
        • -
        • -
          dstpath: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          srcpath: string
        • -
        • -
          dstpath: string
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          flags: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<File>

      -
      - -
        - -
      • -

        Opens the file at path p with the given flag. The file must exist.

        -
        -
        -

        Parameters

        -
          -
        • -
          p: string
          -

          The path to open.

          -
          -
        • -
        • -
          flag: FileFlag
          -

          The flag to use when opening the file.

          -
          -
        • -
        • -
          cred: Cred
        -

        Returns Promise<File>

        -
      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          flag: FileFlag
        • -
        • -
          cred: Cred
        -

        Returns SyncKeyValueFile

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns File

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          fname: string
        • -
        • -
          flag: FileFlag
        • -
        • -
          cred: Cred
        -

        Returns Promise<Uint8Array>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          fname: string
        • -
        • -
          flag: FileFlag
        • -
        • -
          cred: Cred
        -

        Returns Uint8Array

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<string[]>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns string[]

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<string>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns string

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<string>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns string

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          oldPath: string
        • -
        • -
          newPath: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          oldPath: string
        • -
        • -
          newPath: string
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<Stats>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Stats

      -
      - -
        - -
      • -

        Returns boolean

      -
      - -
        - -
      • -

        Returns boolean

      -
      - -
        - -
      • -

        Returns boolean

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          srcpath: string
        • -
        • -
          dstpath: string
        • -
        • -
          type: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          srcpath: string
        • -
        • -
          dstpath: string
        • -
        • -
          type: string
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          len: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          len: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          atime: Date
        • -
        • -
          mtime: Date
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          atime: Date
        • -
        • -
          mtime: Date
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -

        Returns Promise<StorageFileSystem>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          fname: string
        • -
        • -
          data: Uint8Array
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          fname: string
        • -
        • -
          data: Uint8Array
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          storage: Storage = globalThis.localStorage
        -

        Returns boolean

      -
      -
      -

      Generated using TypeDoc

      -
      \ No newline at end of file diff --git a/classes/StorageStore.html b/classes/StorageStore.html index 3972ff1..17472f6 100644 --- a/classes/StorageStore.html +++ b/classes/StorageStore.html @@ -26,10 +26,10 @@

      Hierarchy

      Implements

        -
      • SyncKeyValueStore
      • +
      • SyncStore
      • SimpleSyncStore
      +
    • Defined in src/Storage.ts:10
    • @@ -44,13 +44,16 @@

      Properties

      +

      Accessors

      +
      +

      Methods

      Constructors

      @@ -66,53 +69,45 @@

      Parameters

      _storage: Storage

      Returns StorageStore

      +
    • Defined in src/Storage.ts:15
    • Properties

      _storage: Storage
      +
    • Defined in src/Storage.ts:15
    • +
      +

      Accessors

      +
      + +
        +
      • get name(): string
      • +
      • +

        Returns string

      Methods

        - +
      • -
        -

        Parameters

        -
          -
        • -
          type: string
        -

        Returns SyncKeyValueRWTransaction

      +
    • Defined in src/Storage.ts:21
      • Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          key: string
        -

        Returns void

      +
    • Defined in src/Storage.ts:17
    • Returns Uint8Array

      -
      - -
      +
    • Defined in src/Storage.ts:26
    • +
    • Defined in src/Storage.ts:35
    • +
      + +
        + +
      • +
        +

        Parameters

        +
          +
        • +
          key: bigint
        +

        Returns void

      +
    • put
    • +
    • remove
    • +
    • IndexedDBOptions
    • +
    • StorageOptions
    • +
    • FileSystemAccess
    • +
    • IndexedDB
    • +
    • Storage
    • Generated using TypeDoc

      \ No newline at end of file diff --git a/classes/WorkerFS-1.html b/classes/WorkerFS-1.html deleted file mode 100644 index 4ccf7ce..0000000 --- a/classes/WorkerFS-1.html +++ /dev/null @@ -1,1169 +0,0 @@ -WorkerFS | BrowserFS DOM
      -
      - -
      -
      -
      -
      - -

      Class WorkerFS

      -
      -

      WorkerFS lets you access a BrowserFS instance that is running in a different -JavaScript context (e.g. access BrowserFS in one of your WebWorkers, or -access BrowserFS running on the main page from a WebWorker).

      -

      For example, to have a WebWorker access files in the main browser thread, -do the following:

      -

      MAIN BROWSER THREAD:

      -
        // Listen for remote file system requests.
      BrowserFS.Backend.WorkerFS.attachRemoteListener(webWorkerObject); -
      -

      WEBWORKER THREAD:

      -
        // Set the remote file system as the root file system.
      BrowserFS.configure({ fs: "WorkerFS", options: { worker: self }}, function(e) {
      // Ready!
      }); -
      -

      Note that synchronous operations are not permitted on the WorkerFS, regardless -of the configuration option of the remote FS.

      -
      -
      -
      -

      Hierarchy

      -
        -
      • BaseFileSystem -
          -
        • WorkerFS
      -
      -
      -
      - -
      -
      -

      Constructors

      -
      - -
        - -
      • -

        Constructs a new WorkerFS instance that connects with BrowserFS running on -the specified worker.

        -
        -
        -

        Parameters

        -
        -

        Returns WorkerFS

        -
      -
      -

      Properties

      -
      - -
      _currentID: number = 0
      -
      - -
      _isInitialized: boolean = false
      -
      - -
      _metadata: FileSystemMetadata
      -
      - -
      _ready: Promise<WorkerFS>
      -
      - -
      _requests: Map<number, WorkerRequest> = ...
      -
      - -
      _worker: Worker
      -
      - -
      Create: any = ...
      -
      - -
      Name: "WorkerFS" = 'WorkerFS'
      -
      -

      Accessors

      -
      - -
        -
      • get metadata(): FileSystemMetadata
      • -
      • -

        Returns FileSystemMetadata

      -
      -

      Methods

      -
      - -
        - -
      • -
        -

        Type Parameters

        -
          -
        • -

          T extends "link" | "open" | "truncate" | "metadata" | "rename" | "whenReady" | "access" | "accessSync" | "renameSync" | "stat" | "statSync" | "openSync" | "unlink" | "unlinkSync" | "rmdir" | "rmdirSync" | "mkdir" | "mkdirSync" | "readdir" | "readdirSync" | "exists" | "existsSync" | "realpath" | "realpathSync" | "truncateSync" | "readFile" | "readFileSync" | "writeFile" | "writeFileSync" | "appendFile" | "appendFileSync" | "chmod" | "chmodSync" | "chown" | "chownSync" | "utimes" | "utimesSync" | "linkSync" | "symlink" | "symlinkSync" | "readlink" | "readlinkSync" | "syncClose"

        -
        -

        Parameters

        -
          -
        • -
          method: T
        • -
        • -
          Rest ...args: (Extract<RPCMessage & {
              args: [srcpath: string, dstpath: string, cred: Cred];
              method: "link";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: [p: string, flag: FileFlag, mode: number, cred: Cred];
              method: "open";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: [p: string, len: number, cred: Cred];
              method: "truncate";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: never;
              method: "metadata";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: [oldPath: string, newPath: string, cred: Cred];
              method: "rename";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: [];
              method: "whenReady";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: [p: string, mode: number, cred: Cred];
              method: "access";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: never;
              method: "accessSync";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: never;
              method: "renameSync";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: [p: string, cred: Cred];
              method: "stat";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: never;
              method: "statSync";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: never;
              method: "openSync";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: [p: string, cred: Cred];
              method: "unlink";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: never;
              method: "unlinkSync";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: [p: string, cred: Cred];
              method: "rmdir";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: never;
              method: "rmdirSync";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: [p: string, mode: number, cred: Cred];
              method: "mkdir";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: never;
              method: "mkdirSync";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: [p: string, cred: Cred];
              method: "readdir";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: never;
              method: "readdirSync";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: [p: string, cred: Cred];
              method: "exists";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: never;
              method: "existsSync";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: [p: string, cred: Cred];
              method: "realpath";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: never;
              method: "realpathSync";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: never;
              method: "truncateSync";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: [fname: string, flag: FileFlag, cred: Cred];
              method: "readFile";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: never;
              method: "readFileSync";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: [fname: string, data: Uint8Array, flag: FileFlag, mode: number, cred: Cred];
              method: "writeFile";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: never;
              method: "writeFileSync";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: [fname: string, data: Uint8Array, flag: FileFlag, mode: number, cred: Cred];
              method: "appendFile";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: never;
              method: "appendFileSync";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: [p: string, mode: number, cred: Cred];
              method: "chmod";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: never;
              method: "chmodSync";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: [p: string, new_uid: number, new_gid: number, cred: Cred];
              method: "chown";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: never;
              method: "chownSync";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: [p: string, atime: Date, mtime: Date, cred: Cred];
              method: "utimes";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: never;
              method: "utimesSync";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: never;
              method: "linkSync";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: [srcpath: string, dstpath: string, type: string, cred: Cred];
              method: "symlink";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: never;
              method: "symlinkSync";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: [p: string, cred: Cred];
              method: "readlink";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: never;
              method: "readlinkSync";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: [];
              method: "metadata";
          }, {
              method: T;
          }> | Extract<RPCMessage & {
              args: [string, File];
              method: "syncClose";
          }, {
              method: T;
          }>)["args"]
        -

        Returns _RPCExtractReturnValue<T>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          fname: string
        • -
        • -
          data: Uint8Array
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          fname: string
        • -
        • -
          data: Uint8Array
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          new_uid: number
        • -
        • -
          new_gid: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          new_uid: number
        • -
        • -
          new_gid: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -

        Create the file at path p with the given mode. Then, open it with the given -flag.

        -
        -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<File>

        -
      -
      - -
        - -
      • -

        Create the file at path p with the given mode. Then, open it with the given -flag.

        -
        -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns File

        -
      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<boolean>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns boolean

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          srcpath: string
        • -
        • -
          dstpath: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          srcpath: string
        • -
        • -
          dstpath: string
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<File>

      -
      - -
        - -
      • -

        Opens the file at path p with the given flag. The file must exist.

        -
        -
        -

        Parameters

        -
          -
        • -
          p: string
          -

          The path to open.

          -
          -
        • -
        • -
          flag: FileFlag
          -

          The flag to use when opening the file.

          -
          -
        • -
        • -
          cred: Cred
        -

        Returns Promise<File>

        -
      -
      - -
        - -
      • -

        Opens the file at path p with the given flag. The file must exist.

        -
        -
        -

        Parameters

        -
          -
        • -
          p: string
          -

          The path to open.

          -
          -
        • -
        • -
          flag: FileFlag
          -

          The flag to use when opening the file.

          -
          -
        • -
        • -
          cred: Cred
        -

        Returns File

        A File object corresponding to the opened file.

        - -
      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns File

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          fname: string
        • -
        • -
          flag: FileFlag
        • -
        • -
          cred: Cred
        -

        Returns Promise<Uint8Array>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          fname: string
        • -
        • -
          flag: FileFlag
        • -
        • -
          cred: Cred
        -

        Returns Uint8Array

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<string[]>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns string[]

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<string>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns string

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<string>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns string

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          oldPath: string
        • -
        • -
          newPath: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          oldPath: string
        • -
        • -
          newPath: string
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<Stats>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Stats

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          srcpath: string
        • -
        • -
          dstpath: string
        • -
        • -
          type: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          srcpath: string
        • -
        • -
          dstpath: string
        • -
        • -
          type: string
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          method: string
        • -
        • -
          fd: File
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          len: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          len: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          atime: Date
        • -
        • -
          mtime: Date
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          p: string
        • -
        • -
          atime: Date
        • -
        • -
          mtime: Date
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
        - -
      • -

        Returns Promise<WorkerFS>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          fname: string
        • -
        • -
          data: Uint8Array
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns Promise<void>

      -
      - -
        - -
      • -
        -

        Parameters

        -
          -
        • -
          fname: string
        • -
        • -
          data: Uint8Array
        • -
        • -
          flag: FileFlag
        • -
        • -
          mode: number
        • -
        • -
          cred: Cred
        -

        Returns void

      -
      - -
      -
      -
      -

      Generated using TypeDoc

      -
      \ No newline at end of file diff --git a/index.html b/index.html index d3e0c50..ee921d1 100644 --- a/index.html +++ b/index.html @@ -13,21 +13,20 @@

      BrowserFS DOM

      BrowserFS DOM Backends

      BrowserFS backends for DOM APIs. DOM APIs are only available natively in browsers.

      -

      Please read the BrowserFS documentation!

      +
      +

      [!IMPORTANT] +Please read the BrowserFS documentation!

      +

      Backends

        -
      • HTTPRequest: Downloads files on-demand from a webserver using fetch.
      • -
      • Storage: Stores files in a Storage object, like localStorage and seesionStorage.
      • +
      • Storage: Stores files in a Storage object, like localStorage and sessionStorage.
      • IndexedDB: Stores files into an IndexedDB object database.
      • -
      • WorkerFS: Lets you mount the BrowserFS file system configured in the main thread in a WebWorker, or the other way around!
      • +
      • FileSystemAccess: Store files using the Web File System API.
      -

      For more information, see the API documentation.

      -

      Installing

      npm install @browserfs/fs-dom
      -
      +

      For more information, see the API documentation.

      Usage

      -

      🛈 The examples are written in ESM. If you are using CJS, you can require the package. If running in a browser you can add a script tag to your HTML pointing to the browser.min.js and use BrowserFS DOM via the global BrowserFS_DOM object.

      +

      [!NOTE]
      The examples are written in ESM. If you are using CJS, you can require the package. If running in a browser you can add a script tag to your HTML pointing to the browser.min.js and use BrowserFS DOM via the global BrowserFS_DOM object.

      -

      You can use DOM backends, though you must register them if you plan on using configure:

      -
      import { configure, fs, registerBackend } from '@browserfs/core';
      import { Storage } from '@browserfs/fs-dom';

      registerBackend(Storage);
      await configure({ fs: 'Storage', options: { storage: localStorage } });

      if (!fs.existsSync('/test.txt')) {
      fs.writeFileSync('/test.txt', 'This will persist across reloads!');
      }

      const contents = fs.readFileSync('/test.txt', 'utf-8');
      console.log(contents); +
      import { configure, fs } from '@browserfs/core';
      import { Storage } from '@browserfs/dom';

      await configure({ backend: Storage, storage: localStorage });

      if (!fs.existsSync('/test.txt')) {
      fs.writeFileSync('/test.txt', 'This will persist across reloads!');
      }

      const contents = fs.readFileSync('/test.txt', 'utf-8');
      console.log(contents);
      @@ -55,24 +54,19 @@

      Backends -
    • Installing
    • Usage
    • +
    • IndexedDBOptions
    • +
    • StorageOptions
    • +
    • FileSystemAccess
    • +
    • IndexedDB
    • +
    • Storage
    • Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/HTTPRequest.Options.html b/interfaces/HTTPRequest.Options.html deleted file mode 100644 index 54cbcbd..0000000 --- a/interfaces/HTTPRequest.Options.html +++ /dev/null @@ -1,99 +0,0 @@ -Options | BrowserFS DOM
      -
      - -
      -
      -
      -
      - -

      Interface Options

      -
      -

      Configuration options for a HTTPRequest file system.

      -
      -
      -
      -

      Hierarchy

      -
        -
      • Options
      -
      -
      -
      - -
      -
      -

      Properties

      -
      -
      -

      Properties

      -
      - -
      baseUrl?: string
      -

      Used as the URL prefix for fetched files. -Default: Fetch files relative to the index.

      -
      -
      -
      - -
      index?: string | HTTPRequestIndex
      -

      URL to a file index as a JSON file or the file index object itself, generated with the make_http_index script. -Defaults to index.json.

      -
      -
      -
      - -
      -
      -

      Generated using TypeDoc

      -
      \ No newline at end of file diff --git a/interfaces/IndexedDBFileSystem.Options.html b/interfaces/IndexedDBOptions.html similarity index 84% rename from interfaces/IndexedDBFileSystem.Options.html rename to interfaces/IndexedDBOptions.html index 2350bd7..ddabc53 100644 --- a/interfaces/IndexedDBFileSystem.Options.html +++ b/interfaces/IndexedDBOptions.html @@ -1,4 +1,4 @@ -Options | BrowserFS DOM
      +IndexedDBOptions | BrowserFS DOM

      Configuration options for the IndexedDB file system.

      @@ -23,10 +22,9 @@

      Interface Options

      Hierarchy

        -
      • Options
      @@ -34,9 +32,9 @@

      Properties

      @@ -47,7 +45,7 @@
      +
    • Defined in src/IndexedDB.ts:182
    • idbFactory?: IDBFactory
      @@ -55,7 +53,7 @@
      +
    • Defined in src/IndexedDB.ts:187
    • storeName?: string
      @@ -63,7 +61,7 @@
      +
    • Defined in src/IndexedDB.ts:177
    • +
    • IndexedDBOptions
    • +
    • StorageOptions
    • +
    • FileSystemAccess
    • +
    • IndexedDB
    • +
    • Storage
    • Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/StorageFileSystem.Options.html b/interfaces/StorageOptions.html similarity index 86% rename from interfaces/StorageFileSystem.Options.html rename to interfaces/StorageOptions.html index bdf9eff..e73d8bb 100644 --- a/interfaces/StorageFileSystem.Options.html +++ b/interfaces/StorageOptions.html @@ -1,4 +1,4 @@ -Options | BrowserFS DOM
      +StorageOptions | BrowserFS DOM

      Options to pass to the StorageFileSystem

      @@ -23,10 +22,9 @@

      Interface Options

      Hierarchy

        -
      • Options
      @@ -34,7 +32,7 @@

      Properties

      @@ -45,7 +43,7 @@
      +
    • Defined in src/Storage.ts:64
    • +
    • IndexedDBOptions
    • +
    • StorageOptions
    • +
    • FileSystemAccess
    • +
    • IndexedDB
    • +
    • Storage
    • Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/WorkerFS.Options.html b/interfaces/WorkerFS.Options.html deleted file mode 100644 index a448c0e..0000000 --- a/interfaces/WorkerFS.Options.html +++ /dev/null @@ -1,83 +0,0 @@ -Options | BrowserFS DOM
      -
      - -
      -
      -
      -
      - -

      Interface Options

      -
      -

      Hierarchy

      -
        -
      • Options
      -
      -
      -
      - -
      -
      -

      Properties

      -
      -
      -

      Properties

      -
      - -
      worker: Worker
      -

      The target worker that you want to connect to, or the current worker if in a worker context.

      -
      -
      -
      - -
      -
      -

      Generated using TypeDoc

      -
      \ No newline at end of file diff --git a/modules.html b/modules.html index dad6f00..66e1cea 100644 --- a/modules.html +++ b/modules.html @@ -16,26 +16,22 @@

      BrowserFS DOM

      Index

      -

      Namespaces

      -
      -

      Classes

      -

      Interfaces

      -
      +
      +

      Variables

      +
      -
      -
      -
        -
      • Preparing search index...
      • -
      • The search index is not available
      BrowserFS DOM
      -
      -
      -
      -
      - -

      Namespace IndexedDBFileSystem

      -
      -
      -

      Index

      -
      -

      Interfaces

      -
      -
      -
      -

      Generated using TypeDoc

      -
      \ No newline at end of file diff --git a/modules/StorageFileSystem.html b/modules/StorageFileSystem.html deleted file mode 100644 index 89ab2cb..0000000 --- a/modules/StorageFileSystem.html +++ /dev/null @@ -1,61 +0,0 @@ -StorageFileSystem | BrowserFS DOM
      -
      - -
      -
      -
      -
      - -

      Namespace StorageFileSystem

      -
      -
      -

      Index

      -
      -

      Interfaces

      -
      -
      -
      -

      Generated using TypeDoc

      -
      \ No newline at end of file diff --git a/interfaces/HTTPRequestIndex.html b/variables/FileSystemAccess.html similarity index 88% rename from interfaces/HTTPRequestIndex.html rename to variables/FileSystemAccess.html index 30a1e3f..83e1167 100644 --- a/interfaces/HTTPRequestIndex.html +++ b/variables/FileSystemAccess.html @@ -1,4 +1,4 @@ -HTTPRequestIndex | BrowserFS DOM
      +FileSystemAccess | BrowserFS DOM
      +
      FileSystemAccess: Backend = ...
      +
    • Defined in src/FileSystemAccess.ts:242
    • +
      IndexedDB: Backend = ...
      +

      A file system that uses the IndexedDB key value file system.

      +
      +
      -
      -
      -

      Index

      -
      -

      Interfaces

      -
      +
    • Defined in src/IndexedDB.ts:194
    • +
      Storage: Backend = ...
      +

      A synchronous file system backed by a Storage (e.g. localStorage).

      +
      +
      -
      -
      -

      Index

      -
      -

      Interfaces

      -
      +
    • Defined in src/Storage.ts:70