@ethlete/query 4.11.0 → 4.12.0

package/lib/query-creator/query-creator.d.ts

@@ -1,8 +1,8 @@
-import { BehaviorSubject } from 'rxjs';
 import { EntityStore } from '../entity';
 import { QueryClient } from '../query-client';
 import { QueryStore } from '../query-store';
 import { BaseArguments, GqlQueryConfig, RestQueryConfig, RouteType } from '../query/query.types';
+import { QueryContainerConfig, QuerySubject } from '../utils';
 import { QueryPrepareFn } from './query-creator.types';
 export declare class QueryCreator<Arguments extends BaseArguments | undefined, Response, Route extends RouteType<Arguments>, Store extends EntityStore<unknown>, Data, Id> {
     private _queryConfig;
@@ -10,5 +10,10 @@ export declare class QueryCreator<Arguments extends BaseArguments | undefined, R
     private _store;
     constructor(_queryConfig: RestQueryConfig<Route, Response, Arguments, Store, Data, Id> | GqlQueryConfig<Route, Response, Arguments, Store, Data, Id>, _client: QueryClient, _store: QueryStore);
     prepare: QueryPrepareFn<Arguments, Response, Route, Store, Data, Id>;
-    behaviorSubject: (initialValue?: ReturnType<typeof this.prepare> | null) => BehaviorSubject<ReturnType<QueryPrepareFn<Arguments, Response, Route, Store, Data, Id>> | null>;
+    createSubject: (initialValue?: ReturnType<typeof this.prepare> | null, config?: QueryContainerConfig) => QuerySubject<ReturnType<QueryPrepareFn<Arguments, Response, Route, Store, Data, Id>> | null>;
+    createSignal: (initialValue?: ReturnType<typeof this.prepare> | null, config?: QueryContainerConfig) => void;
+    /**
+     * @deprecated Use `myQuery.createSubject()` or `myQuery.createSignal()` instead. Will be removed in v5.
+     */
+    behaviorSubject: (initialValue?: ReturnType<typeof this.prepare> | null, config?: QueryContainerConfig) => QuerySubject<ReturnType<QueryPrepareFn<Arguments, Response, Route, Store, Data, Id>> | null>;
 }

package/lib/utils/data.utils.d.ts

@@ -0,0 +1,15 @@
+import { BehaviorSubject } from 'rxjs';
+import { AnyQuery } from '../query';
+export interface QueryContainerConfig {
+    /**
+     * If `true`, the previous query will be aborted when a new query is pushed into the container.
+     * @default false
+     */
+    abortPrevious?: boolean;
+}
+export declare class QuerySubject<T extends AnyQuery | null> extends BehaviorSubject<T> {
+    private _config?;
+    constructor(initialValue?: T, _config?: QueryContainerConfig | undefined);
+    next(value: T): void;
+}
+export declare const querySignal: <T extends AnyQuery | null>(initialValue?: T, config?: QueryContainerConfig) => void;

package/lib/utils/index.d.ts

@@ -1,2 +1,3 @@
+export * from './data.utils';
 export * from './deep-freeze.util';
 export * from './def.util';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethlete/query",
-  "version": "4.11.0",
+  "version": "4.12.0",
   "dependencies": {
     "tslib": "^2.5.0"
   },