tinybase 4.0.0-beta.3 → 4.0.0-beta.5

package/lib/types/tinybase.d.ts

@@ -1,6 +1,5 @@
 /**
  * This is everything.
- *
  * @packageDocumentation
  */
 

package/lib/types/tools.d.ts

@@ -4,10 +4,9 @@
  *
  * This module is not intended to be directly used at runtime in a production
  * environment.
- *
  * @packageDocumentation
  * @module tools
- * @since v2.2
+ * @since v2.2.0
  */
 
 import {Store, TablesSchema, ValuesSchema} from './store.d';
@@ -18,9 +17,8 @@ import {Id} from './common.d';
  * is used for debugging purposes.
  *
  * A StoreStats object is returned from the getStoreStats method.
- *
  * @category Statistics
- * @since v2.2
+ * @since v2.2.0
  */
 export type StoreStats = {
   /**
@@ -57,9 +55,8 @@ export type StoreStats = {
  *
  * A StoreStatsDetail object is added to the StoreStats object (returned from
  * the getStoreStats method) when the `detail` flag is specified.
- *
  * @category Statistics
- * @since v2.2
+ * @since v2.2.0
  */
 export type StoreStatsDetail = {
   /**
@@ -71,9 +68,8 @@ export type StoreStatsDetail = {
 /**
  * The StoreStatsTableDetail type describes a detailed set of statistics about a
  * single Table in the Store, and is used for debugging purposes.
- *
  * @category Statistics
- * @since v2.2
+ * @since v2.2.0
  */
 export type StoreStatsTableDetail = {
   /**
@@ -93,9 +89,8 @@ export type StoreStatsTableDetail = {
 /**
  * The StoreStatsRowDetail type describes statistics about a single Row in the
  * Store, and is used for debugging purposes.
- *
  * @category Statistics
- * @since v2.2
+ * @since v2.2.0
  */
 export type StoreStatsRowDetail = {
   /**
@@ -107,10 +102,9 @@ export type StoreStatsRowDetail = {
 /**
  * A Tools object lets you run various utilities on, and get certain information
  * about, Store objects in development.
- *
  * @see Developer Tools guides
  * @category Tools
- * @since v2.2
+ * @since v2.2.0
  */
 export interface Tools {
   //
@@ -118,7 +112,6 @@ export interface Tools {
   /**
    * The getStoreStats method provides a set of statistics about the Store, and
    * is used for debugging purposes.
-   *
    * @param detail An optional boolean that indicates more detailed stats about
    * the inner structure of the Store should be returned.
    * @returns A StoreStats object containing statistics about the Store.
@@ -169,7 +162,7 @@ export interface Tools {
    * // -> {fido: {rowCells: 2}, felix: {rowCells: 2}, cujo: {rowCells: 2}}
    * ```
    * @category Statistics
-   * @since v2.2
+   * @since v2.2.0
    */
   getStoreStats(detail?: boolean): StoreStats;
 
@@ -187,7 +180,6 @@ export interface Tools {
    * Table object's Row objects to have a consistent type. If a given Cell Id
    * appears in every Row, then a `default` for that Cell is specified in the
    * TablesSchema, based on the most common value found.
-   *
    * @returns A TablesSchema object for the Store.
    * @example
    * This example creates a Tools object and gets the schema of a Store that
@@ -233,7 +225,7 @@ export interface Tools {
    * // -> {type: 'boolean'}
    * ```
    * @category Modelling
-   * @since v3.0
+   * @since v3.0.0
    */
   getStoreTablesSchema(): TablesSchema;
 
@@ -246,7 +238,6 @@ export interface Tools {
    * based on the types of the Values present. Note that, unlike the inference
    * of Cell values in the TablesSchema, it is not able to determine whether a
    * Value should have a default or not.
-   *
    * @returns A ValuesSchema object for the Store.
    * @example
    * This example creates a Tools object and gets the schema of a Store that
@@ -272,7 +263,7 @@ export interface Tools {
    * // -> {open: {type: 'boolean'}, employees: {type: 'number'}}
    * ```
    * @category Modelling
-   * @since v3.0
+   * @since v3.0.0
    */
   getStoreValuesSchema(): ValuesSchema;
 
@@ -333,7 +324,6 @@ export interface Tools {
    * The tables above include just a sample of the generated output. For the
    * full set of methods and types generated by this method, inspect the output
    * directly.
-   *
    * @param storeName The name you want to provide to the generated Store, which
    * should also be used to save the `.d.ts`, `.ts`, and `.tsx` files.
    * @returns A set of four strings representing the contents of the `.d.ts`,
@@ -378,7 +368,7 @@ export interface Tools {
    * // -> 'getPetsTable: (): PetsTable => store.getTable(PETS) as PetsTable,'
    * ```
    * @category Modelling
-   * @since v2.2
+   * @since v2.2.0
    */
   getStoreApi(storeName: string): [string, string, string, string];
 
@@ -409,7 +399,6 @@ export interface Tools {
    *
    * See the documentation for the getStoreApi method for details of the content
    * of the generated files.
-   *
    * @param storeName The name you want to provide to the generated Store, which
    * should also be used to save the `.d.ts`, `.ts`, and `.tsx` files.
    * @returns A set of four strings representing the contents of the `.d.ts`,
@@ -433,7 +422,7 @@ export interface Tools {
    * // -> `export type Tables = {pets?: {[rowId: Id]: {price?: number}}};`
    *
    * const tsLines = ts.split('\n');
-   * console.log(tsLines[81]);
+   * console.log(tsLines[83]);
    * // -> '    hasPetsTable: (): boolean => store.hasTable(PETS),'
    * ```
    * @example
@@ -454,11 +443,11 @@ export interface Tools {
    * // -> 'export type Tables = {pets?: {[rowId: Id]: {price: number}}};'
    *
    * const tsLines = ts.split('\n');
-   * console.log(tsLines[83]);
+   * console.log(tsLines[85]);
    * // -> '    hasPetsTable: (): boolean => store.hasTable(PETS),'
    * ```
    * @category Modelling
-   * @since v2.2
+   * @since v2.2.0
    */
   getPrettyStoreApi(
     storeName: string,
@@ -467,7 +456,6 @@ export interface Tools {
   /**
    * The getStore method returns a reference to the underlying Store that is
    * backing this Tools object.
-   *
    * @returns A reference to the Store.
    * @example
    * This example creates a Tools object against a newly-created Store and
@@ -480,7 +468,7 @@ export interface Tools {
    * // -> 1
    * ```
    * @category Getter
-   * @since v3.0
+   * @since v3.0.0
    */
   getStore(): Store;
   //
@@ -494,7 +482,6 @@ export interface 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.
- *
  * @param store The Store for which to register tools.
  * @returns A reference to the new Tools object.
  * @example
@@ -528,7 +515,7 @@ export interface Tools {
  * // -> true
  * ```
  * @category Creation
- * @since v2.2
+ * @since v2.2.0
  */
 export function createTools(store: Store): Tools;
 //