tinybase 3.1.0-beta.5 → 3.1.1

package/lib/types/with-schemas/tools.d.ts

@@ -171,6 +171,7 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
    * @since v2.2.0
    */
   getStoreStats(detail?: boolean): StoreStats;
+
   /* eslint-enable max-len */
 
   /**
@@ -466,6 +467,12 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
    * The getStore method returns a reference to the underlying Store that is
    * backing this Tools object.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * getStore(): Store;
+   * ```
+   *
    * @returns A reference to the Store.
    * @example
    * This example creates a Tools object against a newly-created Store and
@@ -488,6 +495,12 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
  * The createTools function creates a Tools object, and is the main entry point
  * into the tools module.
  *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * createTools(store: Store): Tools;
+ * ```
+ *
  * A given Store can only have one Tools object associated with it. If you call
  * this function twice on the same Store, your second call will return a
  * reference to the Tools object created by the first.
@@ -530,4 +543,5 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
 export function createTools<Schemas extends OptionalSchemas>(
   store: Store<Schemas>,
 ): Tools<Schemas>;
+
 /* eslint-enable max-len */