Browse Source

docs: fix wrong error name

Sv443 2 months ago
parent
commit
36de140028
4 changed files with 6 additions and 6 deletions
  1. 1 1
      CHANGELOG.md
  2. 1 1
      README-summary.md
  3. 1 1
      README.md
  4. 3 3
      docs.md

+ 1 - 1
CHANGELOG.md

@@ -11,7 +11,7 @@
 - 905fea4: Added function `onDomLoad()` to call a callback and/or resolve a Promise when the DOM is loaded, even retroactively
 - 905fea4: Added function `onDomLoad()` to call a callback and/or resolve a Promise when the DOM is loaded, even retroactively
 - 4264154: Added function `bitSetHas()` to check if a given value is present in a [bitset](https://www.geeksforgeeks.org/cpp-bitset-and-its-application/)
 - 4264154: Added function `bitSetHas()` to check if a given value is present in a [bitset](https://www.geeksforgeeks.org/cpp-bitset-and-its-application/)
 - bf55335: Replaced a bunch of generic `Error`s with the new custom error class instances
 - bf55335: Replaced a bunch of generic `Error`s with the new custom error class instances
-- bf55335: Added custom error classes `ChecksumMismatchError`, `DataMigrationError` and `PlatformError`, extending from the base class `UUError`
+- bf55335: Added custom error classes `ChecksumMismatchError`, `MigrationError` and `PlatformError`, extending from the base class `UUError`
   The base class has the additional property `date` which is the time of the error creation
   The base class has the additional property `date` which is the time of the error creation
 
 
 ### Patch Changes
 ### Patch Changes

+ 1 - 1
README-summary.md

@@ -109,7 +109,7 @@ View the documentation of previous major releases:
 - **Custom Error classes:**
 - **Custom Error classes:**
     - [`UUError`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#uuerror) - base class for all custom UserUtils errors - has a custom `date` prop set to the time of creation
     - [`UUError`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#uuerror) - base class for all custom UserUtils errors - has a custom `date` prop set to the time of creation
     - [`ChecksumMismatchError`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#checksummismatcherror) - thrown when a string of data doesn't match its checksum
     - [`ChecksumMismatchError`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#checksummismatcherror) - thrown when a string of data doesn't match its checksum
-    - [`DataMigrationError`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#datamigrationerror) - thrown when a data migration fails
+    - [`MigrationError`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#migrationerror) - thrown when a data migration fails
     - [`PlatformError`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#platformerror) - thrown when a function is called in an unsupported environment
     - [`PlatformError`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#platformerror) - thrown when a function is called in an unsupported environment
 
 
 <br><br>
 <br><br>

+ 1 - 1
README.md

@@ -112,7 +112,7 @@ View the documentation of previous major releases:
   - [**Custom Error classes**](./docs.md#error-classes)
   - [**Custom Error classes**](./docs.md#error-classes)
     - [`UUError`](./docs.md#uuerror) - base class for all custom UserUtils errors - has a custom `date` prop set to the time of creation
     - [`UUError`](./docs.md#uuerror) - base class for all custom UserUtils errors - has a custom `date` prop set to the time of creation
     - [`ChecksumMismatchError`](./docs.md#checksummismatcherror) - thrown when a string of data doesn't match its checksum
     - [`ChecksumMismatchError`](./docs.md#checksummismatcherror) - thrown when a string of data doesn't match its checksum
-    - [`DataMigrationError`](./docs.md#datamigrationerror) - thrown when a data migration fails
+    - [`MigrationError`](./docs.md#migrationerror) - thrown when a data migration fails
     - [`PlatformError`](./docs.md#platformerror) - thrown when a function is called in an unsupported environment
     - [`PlatformError`](./docs.md#platformerror) - thrown when a function is called in an unsupported environment
 
 
 <br><br>
 <br><br>

+ 3 - 3
docs.md

@@ -101,7 +101,7 @@ For submitting bug reports or feature requests, please use the [GitHub issue tra
   - [**Custom Error classes**](#error-classes)
   - [**Custom Error classes**](#error-classes)
     - [`UUError`](#uuerror) - base class for all custom UserUtils errors - has a custom `date` prop set to the time of creation
     - [`UUError`](#uuerror) - base class for all custom UserUtils errors - has a custom `date` prop set to the time of creation
     - [`ChecksumMismatchError`](#checksummismatcherror) - thrown when a string of data doesn't match its checksum
     - [`ChecksumMismatchError`](#checksummismatcherror) - thrown when a string of data doesn't match its checksum
-    - [`DataMigrationError`](#datamigrationerror) - thrown when a data migration fails
+    - [`MigrationError`](#migrationerror) - thrown when a data migration fails
     - [`PlatformError`](#platformerror) - thrown when a function is called in an unsupported environment
     - [`PlatformError`](#platformerror) - thrown when a function is called in an unsupported environment
 
 
 <br><br>
 <br><br>
@@ -1334,7 +1334,7 @@ This is why you should either immediately repopulate the cache and persistent st
 #### `DataStore.runMigrations()`
 #### `DataStore.runMigrations()`
 Signature: `runMigrations(oldData: any, oldFmtVer: number, resetOnError?: boolean): Promise<TData>`  
 Signature: `runMigrations(oldData: any, oldFmtVer: number, resetOnError?: boolean): Promise<TData>`  
 Runs all necessary migration functions to migrate the given `oldData` to the latest format.  
 Runs all necessary migration functions to migrate the given `oldData` to the latest format.  
-If `resetOnError` is set to `false`, the migration will be aborted and a [`DataMigrationError`](#datamigrationerror) is thrown and no data will be committed. If it is set to `true` (default) and an error is encountered, it will be suppressed and the `defaultData` will be saved to persistent storage and returned.
+If `resetOnError` is set to `false`, the migration will be aborted and a [`MigrationError`](#migrationerror) is thrown and no data will be committed. If it is set to `true` (default) and an error is encountered, it will be suppressed and the `defaultData` will be saved to persistent storage and returned.
 
 
 <br>
 <br>
 
 
@@ -3568,7 +3568,7 @@ Extends from the `UUError` class.
 
 
 <br>
 <br>
 
 
-### DataMigrationError
+### MigrationError
 Thrown when a data migration fails.  
 Thrown when a data migration fails.  
 Extends from the `UUError` class.
 Extends from the `UUError` class.