tinybase 3.1.0-beta.5 → 3.1.1

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

@@ -50,6 +50,15 @@ export type Relationship = {
  * The RelationshipCallback type describes a function that takes a
  * Relationship's Id and a callback to loop over each local Row within it.
  *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * (
+ *   relationshipId: Id,
+ *   forEachRow: (rowCallback: RowCallback) => void,
+ * ) => void;
+ * ```
+ *
  * A RelationshipCallback is provided when using the forEachRelationship method,
  * so that you can do something based on every Relationship in the Relationships
  * object. See that method for specific examples.
@@ -69,6 +78,16 @@ export type RelationshipCallback<Schema extends OptionalTablesSchema> = (
  * The RemoteRowIdListener type describes a function that is used to listen to
  * changes to the remote Row Id end of a Relationship.
  *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * (
+ *   relationships: Relationships,
+ *   relationshipId: Id,
+ *   localRowId: Id,
+ * ) => void;
+ * ```
+ *
  * A RemoteRowIdListener is provided when using the addRemoteRowIdListener
  * method. See that method for specific examples.
  *
@@ -91,6 +110,16 @@ export type RemoteRowIdListener<Schemas extends OptionalSchemas> = (
  * The LocalRowIdsListener type describes a function that is used to listen to
  * changes to the local Row Id ends of a Relationship.
  *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * (
+ *   relationships: Relationships,
+ *   relationshipId: Id,
+ *   remoteRowId: Id,
+ * ) => void;
+ * ```
+ *
  * A LocalRowIdsListener is provided when using the addLocalRowIdsListener
  * method. See that method for specific examples.
  *
@@ -113,6 +142,16 @@ export type LocalRowIdsListener<Schemas extends OptionalSchemas> = (
  * The LinkedRowIdsListener type describes a function that is used to listen to
  * changes to the local Row Id ends of a Relationship.
  *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * (
+ *   relationships: Relationships,
+ *   relationshipId: Id,
+ *   firstRowId: Id,
+ * ) => void;
+ * ```
+ *
  * A LinkedRowIdsListener is provided when using the addLinkedRowIdsListener
  * method. See that method for specific examples.
  *
@@ -259,6 +298,17 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * The setRelationshipDefinition method lets you set the definition of a
    * Relationship.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * setRelationshipDefinition(
+   *   relationshipId: Id,
+   *   localTableId: Id,
+   *   remoteTableId: Id,
+   *   getRemoteRowId: Id | ((getCell: GetCell, localRowId: Id) => Id),
+   * ): Relationships;
+   * ```
+   *
    * Every Relationship definition is identified by a unique Id, and if you
    * re-use an existing Id with this method, the previous definition is
    * overwritten.
@@ -354,6 +404,12 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * The delRelationshipDefinition method removes an existing Relationship
    * definition.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * delRelationshipDefinition(relationshipId: Id): Relationships;
+   * ```
+   *
    * @param relationshipId The Id of the Relationship to remove.
    * @returns A reference to the Relationships object.
    * @example
@@ -394,6 +450,12 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * The getStore method returns a reference to the underlying Store that is
    * backing this Relationships 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 Relationships object against a newly-created Store
@@ -439,6 +501,12 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * The forEachRelationship method takes a function that it will then call for
    * each Relationship in a specified Relationships object.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * forEachRelationship(relationshipCallback: RelationshipCallback): void;
+   * ```
+   *
    * This method is useful for iterating over the structure of the Relationships
    * object in a functional style. The `relationshipCallback` parameter is a
    * RelationshipCallback function that will be called with the Id of each
@@ -507,6 +575,12 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * The getLocalTableId method returns the Id of the underlying local Table
    * that is used in the Relationship.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * getLocalTableId(relationshipId: Id): Id | undefined;
+   * ```
+   *
    * If the Relationship Id is invalid, the method returns `undefined`.
    *
    * @param relationshipId The Id of a Relationship.
@@ -541,6 +615,12 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * The getRemoteTableId method returns the Id of the underlying remote Table
    * that is used in the Relationship.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * getRemoteTableId(relationshipId: Id): Id | undefined;
+   * ```
+   *
    * If the Relationship Id is invalid, the method returns `undefined`.
    *
    * @param relationshipId The Id of a Relationship.
@@ -719,6 +799,16 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * Relationships object that will be called whenever a remote Row Id in a
    * Relationship changes.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * addRemoteRowIdListener(
+   *   relationshipId: IdOrNull,
+   *   localRowId: IdOrNull,
+   *   listener: RemoteRowIdListener,
+   * ): Id;
+   * ```
+   *
    * You can either listen to a single local Row (by specifying the Relationship
    * Id and local Row Id as the method's first two parameters), or changes to
    * any local Row (by providing a `null` wildcards).
@@ -850,6 +940,16 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * Relationships object that will be called whenever the local Row Ids in
    * a Relationship change.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * addLocalRowIdsListener(
+   *   relationshipId: IdOrNull,
+   *   remoteRowId: IdOrNull,
+   *   listener: LocalRowIdsListener,
+   * ): Id;
+   * ```
+   *
    * You can either listen to a single local Row (by specifying the Relationship
    * Id and local Row Id as the method's first two parameters), or changes to
    * any local Row (by providing a `null` wildcards).
@@ -976,6 +1076,16 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * Relationships object that will be called whenever the linked Row Ids in a
    * linked list Relationship change.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * addLinkedRowIdsListener(
+   *   relationshipId: Id,
+   *   firstRowId: Id,
+   *   listener: LinkedRowIdsListener,
+   * ): Id;
+   * ```
+   *
    * A linked list Relationship is one that has the same Table specified as both
    * local Table Id and remote Table Id, allowing you to create a sequence of
    * Row objects within that one Table.
@@ -1046,6 +1156,12 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * The delListener method removes a listener that was previously added to the
    * Relationships object.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * delListener(listenerId: Id): Relationships;
+   * ```
+   *
    * Use the Id returned by whichever method was used to add the listener. Note
    * that the Relationships object may re-use this Id for future listeners added
    * to it.
@@ -1185,6 +1301,12 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
  * The createRelationships function creates a Relationships object, and is the
  * main entry point into the relationships module.
  *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * createRelationships(store: Store): Relationships;
+ * ```
+ *
  * A given Store can only have one Relationships object associated with it. If
  * you call this function twice on the same Store, your second call will return
  * a reference to the Relationships object created by the first.