@fgv/ts-web-extras 5.1.0-0 → 5.1.0-10

package/docs/interfaces/FileSystemCreateWritableOptions.md

@@ -0,0 +1,44 @@
+[Home](../README.md) > FileSystemCreateWritableOptions
+
+# Interface: FileSystemCreateWritableOptions
+
+Options for creating writable file streams
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[keepExistingData](./FileSystemCreateWritableOptions.keepExistingData.md)
+
+</td><td>
+
+
+
+</td><td>
+
+boolean
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/FileSystemDirectoryHandle._asyncIterator_.md

@@ -0,0 +1,13 @@
+[Home](../README.md) > [FileSystemDirectoryHandle](./FileSystemDirectoryHandle.md) > [asyncIterator]
+
+## FileSystemDirectoryHandle.[asyncIterator]() method
+
+**Signature:**
+
+```typescript
+[asyncIterator](): AsyncIterableIterator<[string, FileSystemHandle]>;
+```
+
+**Returns:**
+
+AsyncIterableIterator&lt;[string, [FileSystemHandle](FileSystemHandle.md)]&gt;

package/docs/interfaces/FileSystemDirectoryHandle.entries.md

@@ -0,0 +1,13 @@
+[Home](../README.md) > [FileSystemDirectoryHandle](./FileSystemDirectoryHandle.md) > entries
+
+## FileSystemDirectoryHandle.entries() method
+
+**Signature:**
+
+```typescript
+entries(): AsyncIterableIterator<[string, FileSystemHandle]>;
+```
+
+**Returns:**
+
+AsyncIterableIterator&lt;[string, [FileSystemHandle](FileSystemHandle.md)]&gt;

package/docs/interfaces/FileSystemDirectoryHandle.getDirectoryHandle.md

@@ -0,0 +1,21 @@
+[Home](../README.md) > [FileSystemDirectoryHandle](./FileSystemDirectoryHandle.md) > getDirectoryHandle
+
+## FileSystemDirectoryHandle.getDirectoryHandle() method
+
+**Signature:**
+
+```typescript
+getDirectoryHandle(name: string, options?: FileSystemGetDirectoryOptions): Promise<FileSystemDirectoryHandle>;
+```
+
+**Parameters:**
+
+<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
+<tbody>
+<tr><td>name</td><td>string</td><td></td></tr>
+<tr><td>options</td><td>FileSystemGetDirectoryOptions</td><td></td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;[FileSystemDirectoryHandle](FileSystemDirectoryHandle.md)&gt;

package/docs/interfaces/FileSystemDirectoryHandle.getFileHandle.md

@@ -0,0 +1,21 @@
+[Home](../README.md) > [FileSystemDirectoryHandle](./FileSystemDirectoryHandle.md) > getFileHandle
+
+## FileSystemDirectoryHandle.getFileHandle() method
+
+**Signature:**
+
+```typescript
+getFileHandle(name: string, options?: FileSystemGetFileOptions): Promise<FileSystemFileHandle>;
+```
+
+**Parameters:**
+
+<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
+<tbody>
+<tr><td>name</td><td>string</td><td></td></tr>
+<tr><td>options</td><td>FileSystemGetFileOptions</td><td></td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;[FileSystemFileHandle](FileSystemFileHandle.md)&gt;

package/docs/interfaces/FileSystemDirectoryHandle.keys.md

@@ -0,0 +1,13 @@
+[Home](../README.md) > [FileSystemDirectoryHandle](./FileSystemDirectoryHandle.md) > keys
+
+## FileSystemDirectoryHandle.keys() method
+
+**Signature:**
+
+```typescript
+keys(): AsyncIterableIterator<string>;
+```
+
+**Returns:**
+
+AsyncIterableIterator&lt;string&gt;

package/docs/interfaces/FileSystemDirectoryHandle.kind.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [FileSystemDirectoryHandle](./FileSystemDirectoryHandle.md) > kind
+
+## FileSystemDirectoryHandle.kind property
+
+**Signature:**
+
+```typescript
+readonly kind: "directory";
+```

package/docs/interfaces/FileSystemDirectoryHandle.md

@@ -0,0 +1,224 @@
+[Home](../README.md) > FileSystemDirectoryHandle
+
+# Interface: FileSystemDirectoryHandle
+
+Directory handle interface
+
+**Extends:** [`FileSystemHandle`](FileSystemHandle.md)
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[kind](./FileSystemDirectoryHandle.kind.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+"directory"
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[name](./FileSystemHandle.name.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[getDirectoryHandle(name, options)](./FileSystemDirectoryHandle.getDirectoryHandle.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[getFileHandle(name, options)](./FileSystemDirectoryHandle.getFileHandle.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[removeEntry(name, options)](./FileSystemDirectoryHandle.removeEntry.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[resolve(possibleDescendant)](./FileSystemDirectoryHandle.resolve.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[keys()](./FileSystemDirectoryHandle.keys.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[values()](./FileSystemDirectoryHandle.values.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[entries()](./FileSystemDirectoryHandle.entries.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[[asyncIterator]()](./FileSystemDirectoryHandle._asyncIterator_.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[isSameEntry(other)](./FileSystemHandle.isSameEntry.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[queryPermission(descriptor)](./FileSystemHandle.queryPermission.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[requestPermission(descriptor)](./FileSystemHandle.requestPermission.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/FileSystemDirectoryHandle.removeEntry.md

@@ -0,0 +1,21 @@
+[Home](../README.md) > [FileSystemDirectoryHandle](./FileSystemDirectoryHandle.md) > removeEntry
+
+## FileSystemDirectoryHandle.removeEntry() method
+
+**Signature:**
+
+```typescript
+removeEntry(name: string, options?: FileSystemRemoveOptions): Promise<void>;
+```
+
+**Parameters:**
+
+<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
+<tbody>
+<tr><td>name</td><td>string</td><td></td></tr>
+<tr><td>options</td><td>FileSystemRemoveOptions</td><td></td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;void&gt;

package/docs/interfaces/FileSystemDirectoryHandle.resolve.md

@@ -0,0 +1,20 @@
+[Home](../README.md) > [FileSystemDirectoryHandle](./FileSystemDirectoryHandle.md) > resolve
+
+## FileSystemDirectoryHandle.resolve() method
+
+**Signature:**
+
+```typescript
+resolve(possibleDescendant: FileSystemHandle): Promise<string[] | null>;
+```
+
+**Parameters:**
+
+<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
+<tbody>
+<tr><td>possibleDescendant</td><td>FileSystemHandle</td><td></td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;string[] | null&gt;

package/docs/interfaces/FileSystemDirectoryHandle.values.md

@@ -0,0 +1,13 @@
+[Home](../README.md) > [FileSystemDirectoryHandle](./FileSystemDirectoryHandle.md) > values
+
+## FileSystemDirectoryHandle.values() method
+
+**Signature:**
+
+```typescript
+values(): AsyncIterableIterator<FileSystemHandle>;
+```
+
+**Returns:**
+
+AsyncIterableIterator&lt;[FileSystemHandle](FileSystemHandle.md)&gt;

package/docs/interfaces/FileSystemFileHandle.createWritable.md

@@ -0,0 +1,20 @@
+[Home](../README.md) > [FileSystemFileHandle](./FileSystemFileHandle.md) > createWritable
+
+## FileSystemFileHandle.createWritable() method
+
+**Signature:**
+
+```typescript
+createWritable(options?: FileSystemCreateWritableOptions): Promise<FileSystemWritableFileStream>;
+```
+
+**Parameters:**
+
+<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
+<tbody>
+<tr><td>options</td><td>FileSystemCreateWritableOptions</td><td></td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;[FileSystemWritableFileStream](FileSystemWritableFileStream.md)&gt;

package/docs/interfaces/FileSystemFileHandle.getFile.md

@@ -0,0 +1,13 @@
+[Home](../README.md) > [FileSystemFileHandle](./FileSystemFileHandle.md) > getFile
+
+## FileSystemFileHandle.getFile() method
+
+**Signature:**
+
+```typescript
+getFile(): Promise<File>;
+```
+
+**Returns:**
+
+Promise&lt;File&gt;

package/docs/interfaces/FileSystemFileHandle.kind.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [FileSystemFileHandle](./FileSystemFileHandle.md) > kind
+
+## FileSystemFileHandle.kind property
+
+**Signature:**
+
+```typescript
+readonly kind: "file";
+```

package/docs/interfaces/FileSystemFileHandle.md

@@ -0,0 +1,146 @@
+[Home](../README.md) > FileSystemFileHandle
+
+# Interface: FileSystemFileHandle
+
+File handle interface
+
+**Extends:** [`FileSystemHandle`](FileSystemHandle.md)
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[kind](./FileSystemFileHandle.kind.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+"file"
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[name](./FileSystemHandle.name.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[getFile()](./FileSystemFileHandle.getFile.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[createWritable(options)](./FileSystemFileHandle.createWritable.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[isSameEntry(other)](./FileSystemHandle.isSameEntry.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[queryPermission(descriptor)](./FileSystemHandle.queryPermission.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[requestPermission(descriptor)](./FileSystemHandle.requestPermission.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/FileSystemGetDirectoryOptions.create.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [FileSystemGetDirectoryOptions](./FileSystemGetDirectoryOptions.md) > create
+
+## FileSystemGetDirectoryOptions.create property
+
+**Signature:**
+
+```typescript
+create: boolean;
+```

package/docs/interfaces/FileSystemGetDirectoryOptions.md

@@ -0,0 +1,44 @@
+[Home](../README.md) > FileSystemGetDirectoryOptions
+
+# Interface: FileSystemGetDirectoryOptions
+
+Options for getting directory handles
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[create](./FileSystemGetDirectoryOptions.create.md)
+
+</td><td>
+
+
+
+</td><td>
+
+boolean
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/FileSystemGetFileOptions.create.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [FileSystemGetFileOptions](./FileSystemGetFileOptions.md) > create
+
+## FileSystemGetFileOptions.create property
+
+**Signature:**
+
+```typescript
+create: boolean;
+```