@fgv/ts-web-extras 5.1.0-3 → 5.1.0-5

package/docs/classes/LocalStorageTreeAccessors.deleteFile.md

@@ -0,0 +1,24 @@
+[Home](../README.md) > [LocalStorageTreeAccessors](./LocalStorageTreeAccessors.md) > deleteFile
+
+## LocalStorageTreeAccessors.deleteFile() method
+
+Delete a file and remove it from localStorage.
+
+**Signature:**
+
+```typescript
+deleteFile(path: string): Result<boolean>;
+```
+
+**Parameters:**
+
+<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
+<tbody>
+<tr><td>path</td><td>string</td><td>File path to delete</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Result&lt;boolean&gt;
+
+Result with true if deleted, or error

package/docs/classes/LocalStorageTreeAccessors.fileIsMutable.md

@@ -0,0 +1,24 @@
+[Home](../README.md) > [LocalStorageTreeAccessors](./LocalStorageTreeAccessors.md) > fileIsMutable
+
+## LocalStorageTreeAccessors.fileIsMutable() method
+
+Check if a file is mutable and return persistence detail.
+
+**Signature:**
+
+```typescript
+fileIsMutable(path: string): DetailedResult<boolean, SaveDetail>;
+```
+
+**Parameters:**
+
+<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
+<tbody>
+<tr><td>path</td><td>string</td><td>File path to check</td></tr>
+</tbody></table>
+
+**Returns:**
+
+DetailedResult&lt;boolean, SaveDetail&gt;
+
+DetailedResult with mutability status and 'persistent' detail if mutable

package/docs/classes/LocalStorageTreeAccessors.fromStorage.md

@@ -0,0 +1,25 @@
+[Home](../README.md) > [LocalStorageTreeAccessors](./LocalStorageTreeAccessors.md) > fromStorage
+
+## LocalStorageTreeAccessors.fromStorage() method
+
+Create LocalStorageTreeAccessors from browser localStorage.
+Loads all collections from the configured storage keys.
+
+**Signature:**
+
+```typescript
+static fromStorage(params: ILocalStorageTreeParams<TCT>): Result<LocalStorageTreeAccessors<TCT>>;
+```
+
+**Parameters:**
+
+<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
+<tbody>
+<tr><td>params</td><td>ILocalStorageTreeParams&lt;TCT&gt;</td><td>Configuration including path-to-key mappings</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Result&lt;[LocalStorageTreeAccessors](LocalStorageTreeAccessors.md)&lt;TCT&gt;&gt;
+
+Result containing the accessors or an error

package/docs/classes/LocalStorageTreeAccessors.getDirtyPaths.md

@@ -0,0 +1,17 @@
+[Home](../README.md) > [LocalStorageTreeAccessors](./LocalStorageTreeAccessors.md) > getDirtyPaths
+
+## LocalStorageTreeAccessors.getDirtyPaths() method
+
+Get list of file paths with unsaved changes.
+
+**Signature:**
+
+```typescript
+getDirtyPaths(): string[];
+```
+
+**Returns:**
+
+string[]
+
+Array of dirty file paths

package/docs/classes/LocalStorageTreeAccessors.isDirty.md

@@ -0,0 +1,17 @@
+[Home](../README.md) > [LocalStorageTreeAccessors](./LocalStorageTreeAccessors.md) > isDirty
+
+## LocalStorageTreeAccessors.isDirty() method
+
+Check if there are unsaved changes.
+
+**Signature:**
+
+```typescript
+isDirty(): boolean;
+```
+
+**Returns:**
+
+boolean
+
+True if there are dirty files