tinybase 5.0.0-beta.26 → 5.0.0-beta.28

package/@types/tools/with-schemas/index.d.cts

@@ -23,28 +23,40 @@ import type {Id} from '../../common/with-schemas/index.d.cts';
 export type StoreStats = {
   /**
    * The number of Table objects in the Store.
+   * @category Stat
+   * @since v2.2.0
    */
   totalTables: number;
   /**
    * The number of Row objects in the Store, across all Table objects.
+   * @category Stat
+   * @since v2.2.0
    */
   totalRows: number;
   /**
    * The number of Cell objects in the Store, across all Row objects, across all
    * Table objects.
+   * @category Stat
+   * @since v2.2.0
    */
   totalCells: number;
   /**
    * The number of Value objects in the Store, since v3.0.
+   * @category Stat
+   * @since v2.2.0
    */
   totalValues: number;
   /**
    * The string length of the Store when serialized to JSON.
+   * @category Stat
+   * @since v2.2.0
    */
   jsonLength: number;
   /**
    * Additional detailed statistics about the Store if the `detail` flag is
    * specified in the getStoreStats method.
+   * @category Stat
+   * @since v2.2.0
    */
   detail?: StoreStatsDetail;
 };
@@ -61,6 +73,8 @@ export type StoreStats = {
 export type StoreStatsDetail = {
   /**
    * Information about each Table in the Store.
+   * @category Stat
+   * @since v2.2.0
    */
   tables: {[tableId: Id]: StoreStatsTableDetail};
 };
@@ -74,14 +88,20 @@ export type StoreStatsDetail = {
 export type StoreStatsTableDetail = {
   /**
    * The number of Row objects in the Table.
+   * @category Stat
+   * @since v2.2.0
    */
   tableRows: number;
   /**
    * The number of Cell objects in the Table, across all Row objects.
+   * @category Stat
+   * @since v2.2.0
    */
   tableCells: number;
   /**
    * Detail about the Table object.
+   * @category Stat
+   * @since v2.2.0
    */
   rows: {[rowId: Id]: StoreStatsRowDetail};
 };
@@ -95,6 +115,8 @@ export type StoreStatsTableDetail = {
 export type StoreStatsRowDetail = {
   /**
    * The number of Cell objects in the Row.
+   * @category Stat
+   * @since v2.2.0
    */
   rowCells: number;
 };

package/@types/tools/with-schemas/index.d.ts

@@ -23,28 +23,40 @@ import type {Id} from '../../common/with-schemas/index.d.ts';
 export type StoreStats = {
   /**
    * The number of Table objects in the Store.
+   * @category Stat
+   * @since v2.2.0
    */
   totalTables: number;
   /**
    * The number of Row objects in the Store, across all Table objects.
+   * @category Stat
+   * @since v2.2.0
    */
   totalRows: number;
   /**
    * The number of Cell objects in the Store, across all Row objects, across all
    * Table objects.
+   * @category Stat
+   * @since v2.2.0
    */
   totalCells: number;
   /**
    * The number of Value objects in the Store, since v3.0.
+   * @category Stat
+   * @since v2.2.0
    */
   totalValues: number;
   /**
    * The string length of the Store when serialized to JSON.
+   * @category Stat
+   * @since v2.2.0
    */
   jsonLength: number;
   /**
    * Additional detailed statistics about the Store if the `detail` flag is
    * specified in the getStoreStats method.
+   * @category Stat
+   * @since v2.2.0
    */
   detail?: StoreStatsDetail;
 };
@@ -61,6 +73,8 @@ export type StoreStats = {
 export type StoreStatsDetail = {
   /**
    * Information about each Table in the Store.
+   * @category Stat
+   * @since v2.2.0
    */
   tables: {[tableId: Id]: StoreStatsTableDetail};
 };
@@ -74,14 +88,20 @@ export type StoreStatsDetail = {
 export type StoreStatsTableDetail = {
   /**
    * The number of Row objects in the Table.
+   * @category Stat
+   * @since v2.2.0
    */
   tableRows: number;
   /**
    * The number of Cell objects in the Table, across all Row objects.
+   * @category Stat
+   * @since v2.2.0
    */
   tableCells: number;
   /**
    * Detail about the Table object.
+   * @category Stat
+   * @since v2.2.0
    */
   rows: {[rowId: Id]: StoreStatsRowDetail};
 };
@@ -95,6 +115,8 @@ export type StoreStatsTableDetail = {
 export type StoreStatsRowDetail = {
   /**
    * The number of Cell objects in the Row.
+   * @category Stat
+   * @since v2.2.0
    */
   rowCells: number;
 };