tinybase 5.0.0-beta.27 → 5.0.0-beta.28

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

@@ -8,6 +8,7 @@
  * directly, and register listeners for when they change.
  * @packageDocumentation
  * @module relationships
+ * @since v1.0.0
  */
 
 import type {
@@ -40,6 +41,7 @@ import type {Id, IdOrNull, Ids} from '../../common/with-schemas/index.d.ts';
  * instead enumerate and access its structure with the getRemoteRowId method,
  * the getLocalRowIds method, and the getLinkedRowIds method.
  * @category Concept
+ * @since v1.0.0
  */
 export type Relationship = {
   remoteRowId: {[localRowId: Id]: Id};
@@ -68,6 +70,7 @@ export type Relationship = {
  * @param forEachRow A function that will let you iterate over the local Row
  * objects in this Relationship.
  * @category Callback
+ * @since v1.0.0
  */
 export type RelationshipCallback<Schema extends OptionalTablesSchema> = (
   relationshipId: Id,
@@ -91,6 +94,7 @@ export type RelationshipCallback<Schema extends OptionalTablesSchema> = (
  * Relationships object.
  * @param relationships A reference to the Relationships object that changed.
  * @category Listener
+ * @since v1.0.0
  */
 export type RelationshipIdsListener<Schemas extends OptionalSchemas> = (
   relationships: Relationships<Schemas>,
@@ -120,6 +124,7 @@ export type RelationshipIdsListener<Schemas extends OptionalSchemas> = (
  * @param relationshipId The Id of the Relationship that changed.
  * @param localRowId The Id of the local Row whose remote Row Id changed.
  * @category Listener
+ * @since v1.0.0
  */
 export type RemoteRowIdListener<Schemas extends OptionalSchemas> = (
   relationships: Relationships<Schemas>,
@@ -151,6 +156,7 @@ export type RemoteRowIdListener<Schemas extends OptionalSchemas> = (
  * @param relationshipId The Id of the Relationship that changed.
  * @param remoteRowId The Id of the remote Row whose local Row Ids changed.
  * @category Listener
+ * @since v1.0.0
  */
 export type LocalRowIdsListener<Schemas extends OptionalSchemas> = (
   relationships: Relationships<Schemas>,
@@ -183,6 +189,7 @@ export type LocalRowIdsListener<Schemas extends OptionalSchemas> = (
  * @param firstRowId The Id of the first Row of the the linked list whose
  * members changed.
  * @category Listener
+ * @since v1.0.0
  */
 export type LinkedRowIdsListener<Schemas extends OptionalSchemas> = (
   relationships: Relationships<Schemas>,
@@ -198,21 +205,28 @@ export type LinkedRowIdsListener<Schemas extends OptionalSchemas> = (
  * A RelationshipsListenerStats object is returned from the getListenerStats
  * method.
  * @category Development
+ * @since v1.0.0
  */
 export type RelationshipsListenerStats = {
   /**
    * The number of RemoteRowIdListener functions registered with the
    * Relationships object.
+   * @category Stat
+   * @since v1.0.0
    */
   remoteRowId: number;
   /**
    * The number of LocalRowIdsListener functions registered with the
    * Relationships object.
+   * @category Stat
+   * @since v1.0.0
    */
   localRowIds: number;
   /**
    * The number of LinkedRowId functions registered with the Relationships
    * object.
+   * @category Stat
+   * @since v1.0.0
    */
   linkedRowIds: number;
 };
@@ -307,9 +321,10 @@ export type RelationshipsListenerStats = {
  * relationships.delListener(listenerId2);
  * relationships.destroy();
  * ```
- * @see Relationships And Checkpoints guides
+ * @see Using Relationships guide
  * @see Drawing demo
  * @category Relationships
+ * @since v1.0.0
  */
 export interface Relationships<in out Schemas extends OptionalSchemas> {
   /**
@@ -409,6 +424,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * // -> ['fido', 'felix', 'cujo']
    * ```
    * @category Configuration
+   * @since v1.0.0
    */
   setRelationshipDefinition<LocalTableId extends TableIdFromSchema<Schemas[0]>>(
     relationshipId: Id,
@@ -462,6 +478,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * // -> []
    * ```
    * @category Configuration
+   * @since v1.0.0
    */
   delRelationshipDefinition(relationshipId: Id): Relationships<Schemas>;
 
@@ -493,6 +510,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * // -> 'dog'
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getStore(): Store<Schemas>;
 
@@ -513,6 +531,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * // -> ['petSpecies', 'petSequence']
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getRelationshipIds(): Ids;
 
@@ -562,6 +581,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * // -> '- cujo'
    * ```
    * @category Iterator
+   * @since v1.0.0
    */
   forEachRelationship(
     relationshipCallback: RelationshipCallback<Schemas[0]>,
@@ -587,6 +607,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * // -> false
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   hasRelationship(relationshipId: Id): boolean;
 
@@ -625,6 +646,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * // -> undefined
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getLocalTableId<TableId extends TableIdFromSchema<Schemas[0]>>(
     relationshipId: Id,
@@ -665,6 +687,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * // -> undefined
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getRemoteTableId<TableId extends TableIdFromSchema<Schemas[0]>>(
     relationshipId: Id,
@@ -714,6 +737,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * // -> undefined
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getRemoteRowId(relationshipId: Id, localRowId: Id): Id | undefined;
 
@@ -761,6 +785,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * // -> []
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getLocalRowIds(relationshipId: Id, remoteRowId: Id): Ids;
 
@@ -810,6 +835,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * // -> ['fido']
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getLinkedRowIds(relationshipId: Id, firstRowId: Id): Ids;
 
@@ -1006,6 +1032,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * relationships.delListener(listenerId);
    * ```
    * @category Listener
+   * @since v1.0.0
    */
   addRemoteRowIdListener(
     relationshipId: IdOrNull,
@@ -1143,6 +1170,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * relationships.delListener(listenerId);
    * ```
    * @category Listener
+   * @since v1.0.0
    */
   addLocalRowIdsListener(
     relationshipId: IdOrNull,
@@ -1224,6 +1252,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * relationships.delListener(listenerId);
    * ```
    * @category Listener
+   * @since v1.0.0
    */
   addLinkedRowIdsListener(
     relationshipId: Id,
@@ -1290,6 +1319,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * // The listener is not called.
    * ```
    * @category Listener
+   * @since v1.0.0
    */
   delListener(listenerId: Id): Relationships<Schemas>;
 
@@ -1334,6 +1364,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * // -> 0
    * ```
    * @category Lifecycle
+   * @since v1.0.0
    */
   destroy(): void;
 
@@ -1370,6 +1401,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * // -> 1
    * ```
    * @category Development
+   * @since v1.0.0
    */
   getListenerStats(): RelationshipsListenerStats;
 }
@@ -1412,6 +1444,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
  * // -> true
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createRelationships<Schemas extends OptionalSchemas>(
   store: Store<Schemas>,