ngx-lift 1.3.0 → 1.3.1

package/lib/operators/poll.operator.d.ts

@@ -1,18 +1,20 @@
 import { Observable } from 'rxjs';
 import { AsyncState } from '../models';
 /**
- * Polls the API at a specified interval, handling the triggering of requests and building parameters.
+ * Polls data at a specified interval and can be triggered manually.
  *
- * @param {Object} options - The options object containing interval, apiCall, paramsBuilder, and trigger
- * @param {number} options.interval - The interval at which to poll the API
- * @param {(params: Record<string, unknown>) => Observable<Data>} options.apiCall - The function to call the API
- * @param {(input: Input | null) => Record<string, unknown>} [options.paramsBuilder] - The function to build parameters based on input
- * @param {Observable<Input>} [options.trigger] - The trigger observable for initiating requests
- * @return {Observable<AsyncState<Data>>} An observable emitting the async state of the API data
+ * @template Data - The type of the data emitted by the polling function.
+ * @template Input - The type of the input parameter used to build polling parameters.
+ * @param {object} options - The configuration options for polling.
+ * @param {number} options.interval - The interval in milliseconds between each poll.
+ * @param {(params: any) => Observable<Data>} options.pollingFn - A function that returns an Observable emitting the polled data.
+ * @param {(input: Input | null) => any} [options.paramsBuilder] - An optional function that builds parameters for the polling function based on the input.
+ * @param {Observable<Input>} [options.trigger] - An optional Observable that triggers a manual poll.
+ * @returns {Observable<AsyncState<Data>>} An Observable emitting objects representing the state of the asynchronous operation.
  */
 export declare function poll<Data, Input>(options: {
     interval: number;
-    apiCall: (params: Record<string, unknown>) => Observable<Data>;
-    paramsBuilder?: (input: Input | null) => Record<string, unknown>;
+    pollingFn: (params: any) => Observable<Data>;
+    paramsBuilder?: (input: Input | null) => any;
     trigger?: Observable<Input>;
 }): Observable<AsyncState<Data>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ngx-lift",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "A project has been crafted with the goal of enhancing and simplifying your Angular development experience.",
   "author": "Guanghui Wang <guanghui-wang@foxmail.com>",
   "peerDependencies": {