@fgv/ts-web-extras 5.1.0-2 → 5.1.0-4

package/docs/interfaces/FileSystemWritableFileStream.md

@@ -1,127 +1,142 @@
-[**@fgv/ts-web-extras**](../README.md)
-
-***
-
-[@fgv/ts-web-extras](../README.md) / FileSystemWritableFileStream
+[Home](../README.md) > FileSystemWritableFileStream
 
 # Interface: FileSystemWritableFileStream
 
 Writable file stream interface
 
-## Extends
-
-- `WritableStream`
+**Extends:** `WritableStream`
 
 ## Properties
 
-| Property | Modifier | Type | Description |
-| ------ | ------ | ------ | ------ |
-| <a id="locked"></a> `locked` | `readonly` | `boolean` | The **`locked`** read-only property of the WritableStream interface returns a boolean indicating whether the `WritableStream` is locked to a writer. [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/locked) |
+<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
 
-### abort()
+<table><thead><tr><th>
 
-> **abort**(`reason?`): `Promise`\<`void`\>
+Method
 
-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.
+</th><th>
 
-[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/abort)
+Modifiers
 
-#### Parameters
+</th><th>
 
-| Parameter | Type |
-| ------ | ------ |
-| `reason?` | `any` |
+Description
 
-#### Returns
+</th></tr></thead>
+<tbody>
+<tr><td>
 
-`Promise`\<`void`\>
+[write(data)](./FileSystemWritableFileStream.write.md)
 
-#### Inherited from
+</td><td>
 
-`WritableStream.abort`
 
-***
 
-### close()
+</td><td>
 
-> **close**(): `Promise`\<`void`\>
 
-The **`close()`** method of the WritableStream interface closes the associated stream.
 
-[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/close)
+</td></tr>
+<tr><td>
 
-#### Returns
+[seek(position)](./FileSystemWritableFileStream.seek.md)
 
-`Promise`\<`void`\>
+</td><td>
 
-#### Inherited from
 
-`WritableStream.close`
 
-***
+</td><td>
 
-### getWriter()
 
-> **getWriter**(): `WritableStreamDefaultWriter`\<`any`\>
 
-The **`getWriter()`** method of the WritableStream interface returns a new instance of WritableStreamDefaultWriter and locks the stream to that instance.
+</td></tr>
+<tr><td>
+
+[truncate(size)](./FileSystemWritableFileStream.truncate.md)
 
-[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/getWriter)
+</td><td>
 
-#### Returns
 
-`WritableStreamDefaultWriter`\<`any`\>
 
-#### Inherited from
+</td><td>
 
-`WritableStream.getWriter`
 
-***
 
-### seek()
+</td></tr>
+<tr><td>
 
-> **seek**(`position`): `Promise`\<`void`\>
+[abort(reason)](./FileSystemWritableFileStream.abort.md)
 
-#### Parameters
+</td><td>
 
-| Parameter | Type |
-| ------ | ------ |
-| `position` | `number` |
 
-#### Returns
 
-`Promise`\<`void`\>
+</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.
 
-### truncate()
+</td></tr>
+<tr><td>
 
-> **truncate**(`size`): `Promise`\<`void`\>
+[close()](./FileSystemWritableFileStream.close.md)
 
-#### Parameters
+</td><td>
 
-| Parameter | Type |
-| ------ | ------ |
-| `size` | `number` |
 
-#### Returns
 
-`Promise`\<`void`\>
+</td><td>
 
-***
+The **`close()`** method of the WritableStream interface closes the associated stream.
 
-### write()
+</td></tr>
+<tr><td>
 
-> **write**(`data`): `Promise`\<`void`\>
+[getWriter()](./FileSystemWritableFileStream.getWriter.md)
 
-#### Parameters
+</td><td>
 
-| Parameter | Type |
-| ------ | ------ |
-| `data` | `string` \| `BufferSource` \| `Blob` |
 
-#### Returns
 
-`Promise`\<`void`\>
+</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

@@ -1,8 +1,4 @@
-[**@fgv/ts-web-extras**](../README.md)
-
-***
-
-[@fgv/ts-web-extras](../README.md) / IDirectoryHandleTreeInitializer
+[Home](../README.md) > IDirectoryHandleTreeInitializer
 
 # Interface: IDirectoryHandleTreeInitializer
 
@@ -10,8 +6,73 @@ Tree initializer for File System Access API directory handles.
 
 ## Properties
 
-| Property | Modifier | Type |
-| ------ | ------ | ------ |
-| <a id="dirhandles"></a> `dirHandles` | `readonly` | [`FileSystemDirectoryHandle`](FileSystemDirectoryHandle.md)[] |
-| <a id="nonrecursive"></a> `nonRecursive?` | `readonly` | `boolean` |
-| <a id="prefix"></a> `prefix?` | `readonly` | `string` |
+<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[];
+```

package/docs/interfaces/IFileHandleTreeInitializer.md

@@ -1,8 +1,4 @@
-[**@fgv/ts-web-extras**](../README.md)
-
-***
-
-[@fgv/ts-web-extras](../README.md) / IFileHandleTreeInitializer
+[Home](../README.md) > IFileHandleTreeInitializer
 
 # Interface: IFileHandleTreeInitializer
 
@@ -10,7 +6,56 @@ Tree initializer for File System Access API file handles.
 
 ## Properties
 
-| Property | Modifier | Type |
-| ------ | ------ | ------ |
-| <a id="filehandles"></a> `fileHandles` | `readonly` | [`FileSystemFileHandle`](FileSystemFileHandle.md)[] |
-| <a id="prefix"></a> `prefix?` | `readonly` | `string` |
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[prefix](./IFileHandleTreeInitializer.prefix.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[fileHandles](./IFileHandleTreeInitializer.fileHandles.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+[FileSystemFileHandle](FileSystemFileHandle.md)[]
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/IFileHandleTreeInitializer.prefix.md

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

package/docs/interfaces/IFileListTreeInitializer.fileList.md

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

package/docs/interfaces/IFileListTreeInitializer.md

@@ -1,8 +1,4 @@
-[**@fgv/ts-web-extras**](../README.md)
-
-***
-
-[@fgv/ts-web-extras](../README.md) / IFileListTreeInitializer
+[Home](../README.md) > IFileListTreeInitializer
 
 # Interface: IFileListTreeInitializer
 
@@ -10,6 +6,39 @@ Tree initializer for FileList objects (from File API).
 
 ## Properties
 
-| Property | Modifier | Type |
-| ------ | ------ | ------ |
-| <a id="filelist"></a> `fileList` | `readonly` | `FileList` |
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[fileList](./IFileListTreeInitializer.fileList.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+FileList
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/IFileMetadata.lastModified.md

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

package/docs/interfaces/IFileMetadata.md

@@ -1,8 +1,4 @@
-[**@fgv/ts-web-extras**](../README.md)
-
-***
-
-[@fgv/ts-web-extras](../README.md) / IFileMetadata
+[Home](../README.md) > IFileMetadata
 
 # Interface: IFileMetadata
 
@@ -10,10 +6,107 @@ Interface for file metadata.
 
 ## Properties
 
-| Property | Type |
-| ------ | ------ |
-| <a id="lastmodified"></a> `lastModified` | `number` |
-| <a id="name"></a> `name` | `string` |
-| <a id="path"></a> `path` | `string` |
-| <a id="size"></a> `size` | `number` |
-| <a id="type"></a> `type` | `string` |
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[path](./IFileMetadata.path.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[name](./IFileMetadata.name.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[size](./IFileMetadata.size.md)
+
+</td><td>
+
+
+
+</td><td>
+
+number
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[type](./IFileMetadata.type.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[lastModified](./IFileMetadata.lastModified.md)
+
+</td><td>
+
+
+
+</td><td>
+
+number
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/IFileMetadata.name.md

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