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

package/docs/interfaces/FileSystemGetFileOptions.md

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

package/docs/interfaces/FileSystemHandle.isSameEntry.md

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

package/docs/interfaces/FileSystemHandle.kind.md

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

package/docs/interfaces/FileSystemHandle.md

@@ -0,0 +1,118 @@
+[Home](../README.md) > FileSystemHandle
+
+# Interface: FileSystemHandle
+
+Base interface for file system handles
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[kind](./FileSystemHandle.kind.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+"file" | "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>
+
+[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/FileSystemHandle.name.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [FileSystemHandle](./FileSystemHandle.md) > name
+
+## FileSystemHandle.name property
+
+**Signature:**
+
+```typescript
+readonly name: string;
+```

package/docs/interfaces/FileSystemHandle.queryPermission.md

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

package/docs/interfaces/FileSystemHandle.requestPermission.md

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

package/docs/interfaces/FileSystemHandlePermissionDescriptor.md

@@ -0,0 +1,44 @@
+[Home](../README.md) > FileSystemHandlePermissionDescriptor
+
+# Interface: FileSystemHandlePermissionDescriptor
+
+Permission descriptor for file system handles
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[mode](./FileSystemHandlePermissionDescriptor.mode.md)
+
+</td><td>
+
+
+
+</td><td>
+
+"readwrite" | "read"
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/FileSystemHandlePermissionDescriptor.mode.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [FileSystemHandlePermissionDescriptor](./FileSystemHandlePermissionDescriptor.md) > mode
+
+## FileSystemHandlePermissionDescriptor.mode property
+
+**Signature:**
+
+```typescript
+mode: "readwrite" | "read";
+```

package/docs/interfaces/FileSystemRemoveOptions.md

@@ -0,0 +1,44 @@
+[Home](../README.md) > FileSystemRemoveOptions
+
+# Interface: FileSystemRemoveOptions
+
+Options for removing entries
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[recursive](./FileSystemRemoveOptions.recursive.md)
+
+</td><td>
+
+
+
+</td><td>
+
+boolean
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/FileSystemRemoveOptions.recursive.md

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

package/docs/interfaces/FileSystemWritableFileStream.md

@@ -0,0 +1,142 @@
+[Home](../README.md) > FileSystemWritableFileStream
+
+# Interface: FileSystemWritableFileStream
+
+Writable file stream interface
+
+**Extends:** `WritableStream`
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[locked](./FileSystemWritableFileStream.locked.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+boolean
+
+</td><td>
+
+The **`locked`** read-only property of the WritableStream interface returns a boolean indicating whether the `WritableStream` is locked to a writer.
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[write(data)](./FileSystemWritableFileStream.write.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[seek(position)](./FileSystemWritableFileStream.seek.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[truncate(size)](./FileSystemWritableFileStream.truncate.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[abort(reason)](./FileSystemWritableFileStream.abort.md)
+
+</td><td>
+
+
+
+</td><td>
+
+The **`abort()`** method of the WritableStream interface aborts the stream, signaling that the producer can no longer successfully write to the stream and it is to be immediately moved to an error state, with any queued writes discarded.
+
+</td></tr>
+<tr><td>
+
+[close()](./FileSystemWritableFileStream.close.md)
+
+</td><td>
+
+
+
+</td><td>
+
+The **`close()`** method of the WritableStream interface closes the associated stream.
+
+</td></tr>
+<tr><td>
+
+[getWriter()](./FileSystemWritableFileStream.getWriter.md)
+
+</td><td>
+
+
+
+</td><td>
+
+The **`getWriter()`** method of the WritableStream interface returns a new instance of WritableStreamDefaultWriter and locks the stream to that instance.
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/FileSystemWritableFileStream.seek.md

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

package/docs/interfaces/FileSystemWritableFileStream.truncate.md

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

package/docs/interfaces/FileSystemWritableFileStream.write.md

@@ -0,0 +1,20 @@
+[Home](../README.md) > [FileSystemWritableFileStream](./FileSystemWritableFileStream.md) > write
+
+## FileSystemWritableFileStream.write() method
+
+**Signature:**
+
+```typescript
+write(data: string | BufferSource | Blob): Promise<void>;
+```
+
+**Parameters:**
+
+<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
+<tbody>
+<tr><td>data</td><td>string | BufferSource | Blob</td><td></td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;void&gt;

package/docs/interfaces/IDirectoryHandleTreeInitializer.dirHandles.md

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

package/docs/interfaces/IDirectoryHandleTreeInitializer.md

@@ -0,0 +1,78 @@
+[Home](../README.md) > IDirectoryHandleTreeInitializer
+
+# Interface: IDirectoryHandleTreeInitializer
+
+Tree initializer for File System Access API directory handles.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[prefix](./IDirectoryHandleTreeInitializer.prefix.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[dirHandles](./IDirectoryHandleTreeInitializer.dirHandles.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+[FileSystemDirectoryHandle](FileSystemDirectoryHandle.md)[]
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[nonRecursive](./IDirectoryHandleTreeInitializer.nonRecursive.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+boolean
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/IDirectoryHandleTreeInitializer.nonRecursive.md

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

package/docs/interfaces/IDirectoryHandleTreeInitializer.prefix.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [IDirectoryHandleTreeInitializer](./IDirectoryHandleTreeInitializer.md) > prefix
+
+## IDirectoryHandleTreeInitializer.prefix property
+
+**Signature:**
+
+```typescript
+readonly prefix: string;
+```

package/docs/interfaces/IFileHandleTreeInitializer.fileHandles.md

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