Skip to content

Commit 4edb977

Browse files
cleanup interfaces
1 parent 8a42cda commit 4edb977

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

packages/common/src/client/AbstractPowerSyncDatabase.ts

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ export interface PowerSyncDatabaseOptionsWithSettings extends BasePowerSyncDatab
7272
database: SQLOpenOptions;
7373
}
7474

75-
export interface SQLWatchOptions {
75+
export interface SQLOnChangeOptions {
7676
signal?: AbortSignal;
7777
tables?: string[];
7878
/** The minimum interval between queries. */
@@ -88,7 +88,9 @@ export interface SQLWatchOptions {
8888
* Emits an empty result set immediately
8989
*/
9090
triggerImmediate?: boolean;
91+
}
9192

93+
export interface SQLWatchOptions extends SQLOnChangeOptions {
9294
/**
9395
* Optional comparator which will be used to compare the results of the query.
9496
* The watched query will only yield results if the comparator returns false.
@@ -1039,7 +1041,7 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
10391041
* }
10401042
* ```
10411043
*/
1042-
onChange(options?: SQLWatchOptions): AsyncIterable<WatchOnChangeEvent>;
1044+
onChange(options?: SQLOnChangeOptions): AsyncIterable<WatchOnChangeEvent>;
10431045
/**
10441046
* See {@link onChangeWithCallback}.
10451047
*
@@ -1054,11 +1056,11 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
10541056
* }
10551057
* ```
10561058
*/
1057-
onChange(handler?: WatchOnChangeHandler, options?: SQLWatchOptions): () => void;
1059+
onChange(handler?: WatchOnChangeHandler, options?: SQLOnChangeOptions): () => void;
10581060

10591061
onChange(
1060-
handlerOrOptions?: WatchOnChangeHandler | SQLWatchOptions,
1061-
maybeOptions?: SQLWatchOptions
1062+
handlerOrOptions?: WatchOnChangeHandler | SQLOnChangeOptions,
1063+
maybeOptions?: SQLOnChangeOptions
10621064
): (() => void) | AsyncIterable<WatchOnChangeEvent> {
10631065
if (handlerOrOptions && typeof handlerOrOptions === 'object' && 'onChange' in handlerOrOptions) {
10641066
const handler = handlerOrOptions as WatchOnChangeHandler;
@@ -1083,7 +1085,7 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
10831085
* @param options Options for configuring watch behavior
10841086
* @returns A dispose function to stop watching for changes
10851087
*/
1086-
onChangeWithCallback(handler?: WatchOnChangeHandler, options?: SQLWatchOptions): () => void {
1088+
onChangeWithCallback(handler?: WatchOnChangeHandler, options?: SQLOnChangeOptions): () => void {
10871089
const { onChange, onError = (e: Error) => this.options.logger?.error(e) } = handler ?? {};
10881090
if (!onChange) {
10891091
throw new Error('onChange is required');

0 commit comments

Comments
 (0)