@mastra/nestjs 0.2.5-alpha.0 → 0.2.5-alpha.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/dist/_types/rxjs/dist/types/internal/AsyncSubject.d.ts +0 -2
  3. package/dist/_types/rxjs/dist/types/internal/BehaviorSubject.d.ts +0 -2
  4. package/dist/_types/rxjs/dist/types/internal/Notification.d.ts +5 -10
  5. package/dist/_types/rxjs/dist/types/internal/Observable.d.ts +7 -14
  6. package/dist/_types/rxjs/dist/types/internal/ReplaySubject.d.ts +3 -3
  7. package/dist/_types/rxjs/dist/types/internal/Scheduler.d.ts +8 -10
  8. package/dist/_types/rxjs/dist/types/internal/Subject.d.ts +1 -5
  9. package/dist/_types/rxjs/dist/types/internal/Subscriber.d.ts +3 -9
  10. package/dist/_types/rxjs/dist/types/internal/Subscription.d.ts +0 -4
  11. package/dist/_types/rxjs/dist/types/internal/observable/defer.d.ts +5 -6
  12. package/dist/_types/rxjs/dist/types/internal/observable/generate.d.ts +21 -18
  13. package/dist/_types/rxjs/dist/types/internal/observable/interval.d.ts +5 -6
  14. package/dist/_types/rxjs/dist/types/internal/observable/using.d.ts +3 -5
  15. package/dist/_types/rxjs/dist/types/internal/operators/auditTime.d.ts +5 -5
  16. package/dist/_types/rxjs/dist/types/internal/operators/bufferCount.d.ts +2 -2
  17. package/dist/_types/rxjs/dist/types/internal/operators/bufferWhen.d.ts +2 -2
  18. package/dist/_types/rxjs/dist/types/internal/operators/debounceTime.d.ts +5 -6
  19. package/dist/_types/rxjs/dist/types/internal/operators/delay.d.ts +4 -4
  20. package/dist/_types/rxjs/dist/types/internal/operators/elementAt.d.ts +4 -4
  21. package/dist/_types/rxjs/dist/types/internal/operators/finalize.d.ts +1 -1
  22. package/dist/_types/rxjs/dist/types/internal/operators/max.d.ts +5 -4
  23. package/dist/_types/rxjs/dist/types/internal/operators/mergeAll.d.ts +2 -2
  24. package/dist/_types/rxjs/dist/types/internal/operators/mergeScan.d.ts +3 -4
  25. package/dist/_types/rxjs/dist/types/internal/operators/min.d.ts +5 -4
  26. package/dist/_types/rxjs/dist/types/internal/operators/repeat.d.ts +2 -2
  27. package/dist/_types/rxjs/dist/types/internal/operators/repeatWhen.d.ts +1 -1
  28. package/dist/_types/rxjs/dist/types/internal/operators/retryWhen.d.ts +1 -1
  29. package/dist/_types/rxjs/dist/types/internal/operators/sampleTime.d.ts +4 -4
  30. package/dist/_types/rxjs/dist/types/internal/operators/skip.d.ts +1 -1
  31. package/dist/_types/rxjs/dist/types/internal/operators/takeUntil.d.ts +2 -3
  32. package/dist/_types/rxjs/dist/types/internal/operators/timeInterval.d.ts +1 -1
  33. package/dist/_types/rxjs/dist/types/internal/operators/timeout.d.ts +0 -2
  34. package/dist/_types/rxjs/dist/types/internal/operators/windowCount.d.ts +5 -6
  35. package/dist/_types/rxjs/dist/types/internal/operators/windowToggle.d.ts +4 -6
  36. package/dist/_types/rxjs/dist/types/internal/operators/windowWhen.d.ts +4 -3
  37. package/dist/_types/rxjs/dist/types/internal/scheduler/Action.d.ts +5 -7
  38. package/dist/_types/rxjs/dist/types/internal/scheduler/AsyncAction.d.ts +0 -1
  39. package/dist/_types/rxjs/dist/types/internal/scheduler/VirtualTimeScheduler.d.ts +0 -1
  40. package/dist/_types/rxjs/dist/types/internal/types.d.ts +6 -0
  41. package/dist/_types/rxjs/dist/types/internal/util/ArgumentOutOfRangeError.d.ts +0 -2
  42. package/dist/_types/rxjs/dist/types/internal/util/EmptyError.d.ts +0 -2
  43. package/dist/_types/rxjs/dist/types/internal/util/NotFoundError.d.ts +0 -2
  44. package/dist/_types/rxjs/dist/types/internal/util/SequenceError.d.ts +0 -2
  45. package/dist/index.cjs +460 -457
  46. package/dist/index.cjs.map +1 -1
  47. package/dist/index.js +460 -457
  48. package/dist/index.js.map +1 -1
  49. package/package.json +8 -8
package/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # @mastra/nestjs
2
2
 
3
+ ## 0.2.5-alpha.2
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies [[`a51c63d`](https://github.com/mastra-ai/mastra/commit/a51c63d8ee639e4daeba2a0be093efa6a1b5e52f), [`02705fd`](https://github.com/mastra-ai/mastra/commit/02705fd2f5a9062210d64ea061adeeb10dc9452e)]:
8
+ - @mastra/core@1.50.0-alpha.2
9
+ - @mastra/server@1.50.0-alpha.2
10
+
11
+ ## 0.2.5-alpha.1
12
+
13
+ ### Patch Changes
14
+
15
+ - Updated dependencies [[`3ffb8b7`](https://github.com/mastra-ai/mastra/commit/3ffb8b720e90f5e6977129ec1f6707d43c2bebe0), [`5ea76a7`](https://github.com/mastra-ai/mastra/commit/5ea76a723d966c72da9aa3ab30ae20276e049765), [`6445560`](https://github.com/mastra-ai/mastra/commit/6445560327045d20b239585fc63fed72e9ce36ec), [`a2ba369`](https://github.com/mastra-ai/mastra/commit/a2ba369e796dfab610f41c6875965b488272fa55), [`ae51e81`](https://github.com/mastra-ai/mastra/commit/ae51e818825582d42500338dfc1929a082eff0ba), [`6f304ef`](https://github.com/mastra-ai/mastra/commit/6f304ef319e99725e884bdb8d3193c001b6e5964)]:
16
+ - @mastra/core@1.50.0-alpha.1
17
+ - @mastra/server@1.50.0-alpha.1
18
+
3
19
  ## 0.2.5-alpha.0
4
20
 
5
21
  ### Patch Changes
@@ -2,8 +2,6 @@ import { Subject } from './Subject';
2
2
  /**
3
3
  * A variant of Subject that only emits a value when it completes. It will emit
4
4
  * its latest value to all its observers on completion.
5
- *
6
- * @class AsyncSubject<T>
7
5
  */
8
6
  export declare class AsyncSubject<T> extends Subject<T> {
9
7
  private _value;
@@ -2,8 +2,6 @@ import { Subject } from './Subject';
2
2
  /**
3
3
  * A variant of Subject that requires an initial value and emits its current
4
4
  * value whenever it is subscribed to.
5
- *
6
- * @class BehaviorSubject<T>
7
5
  */
8
6
  export declare class BehaviorSubject<T> extends Subject<T> {
9
7
  private _value;
@@ -135,10 +135,8 @@ export declare class Notification<T> {
135
135
  /**
136
136
  * A shortcut to create a Notification instance of the type `next` from a
137
137
  * given value.
138
- * @param {T} value The `next` value.
139
- * @return {Notification<T>} The "next" Notification representing the
140
- * argument.
141
- * @nocollapse
138
+ * @param value The `next` value.
139
+ * @return The "next" Notification representing the argument.
142
140
  * @deprecated It is NOT recommended to create instances of `Notification` directly.
143
141
  * Rather, try to create POJOs matching the signature outlined in {@link ObservableNotification}.
144
142
  * For example: `{ kind: 'N', value: 1 }`, `{ kind: 'E', error: new Error('bad') }`, or `{ kind: 'C' }`.
@@ -148,10 +146,8 @@ export declare class Notification<T> {
148
146
  /**
149
147
  * A shortcut to create a Notification instance of the type `error` from a
150
148
  * given error.
151
- * @param {any} [err] The `error` error.
152
- * @return {Notification<T>} The "error" Notification representing the
153
- * argument.
154
- * @nocollapse
149
+ * @param err The `error` error.
150
+ * @return The "error" Notification representing the argument.
155
151
  * @deprecated It is NOT recommended to create instances of `Notification` directly.
156
152
  * Rather, try to create POJOs matching the signature outlined in {@link ObservableNotification}.
157
153
  * For example: `{ kind: 'N', value: 1 }`, `{ kind: 'E', error: new Error('bad') }`, or `{ kind: 'C' }`.
@@ -160,8 +156,7 @@ export declare class Notification<T> {
160
156
  static createError(err?: any): Notification<never> & ErrorNotification;
161
157
  /**
162
158
  * A shortcut to create a Notification instance of the type `complete`.
163
- * @return {Notification<any>} The valueless "complete" Notification.
164
- * @nocollapse
159
+ * @return The valueless "complete" Notification.
165
160
  * @deprecated It is NOT recommended to create instances of `Notification` directly.
166
161
  * Rather, try to create POJOs matching the signature outlined in {@link ObservableNotification}.
167
162
  * For example: `{ kind: 'N', value: 1 }`, `{ kind: 'E', error: new Error('bad') }`, or `{ kind: 'C' }`.
@@ -5,8 +5,6 @@ import { TeardownLogic, OperatorFunction, Subscribable, Observer } from './types
5
5
  /**
6
6
  * A representation of any set of values over any amount of time. This is the most basic building block
7
7
  * of RxJS.
8
- *
9
- * @class Observable<T>
10
8
  */
11
9
  export declare class Observable<T> implements Subscribable<T> {
12
10
  /**
@@ -18,8 +16,7 @@ export declare class Observable<T> implements Subscribable<T> {
18
16
  */
19
17
  operator: Operator<any, T> | undefined;
20
18
  /**
21
- * @constructor
22
- * @param {Function} subscribe the function that is called when the Observable is
19
+ * @param subscribe The function that is called when the Observable is
23
20
  * initially subscribed to. This function is given a Subscriber, to which new values
24
21
  * can be `next`ed, or an `error` method can be called to raise an error, or
25
22
  * `complete` can be called to notify of a successful completion.
@@ -27,20 +24,16 @@ export declare class Observable<T> implements Subscribable<T> {
27
24
  constructor(subscribe?: (this: Observable<T>, subscriber: Subscriber<T>) => TeardownLogic);
28
25
  /**
29
26
  * Creates a new Observable by calling the Observable constructor
30
- * @owner Observable
31
- * @method create
32
- * @param {Function} subscribe? the subscriber function to be passed to the Observable constructor
33
- * @return {Observable} a new observable
34
- * @nocollapse
27
+ * @param subscribe the subscriber function to be passed to the Observable constructor
28
+ * @return A new observable.
35
29
  * @deprecated Use `new Observable()` instead. Will be removed in v8.
36
30
  */
37
31
  static create: (...args: any[]) => any;
38
32
  /**
39
33
  * Creates a new Observable, with this Observable instance as the source, and the passed
40
34
  * operator defined as the new observable's operator.
41
- * @method lift
42
35
  * @param operator the operator defining the operation to take on the observable
43
- * @return a new observable with the Operator applied
36
+ * @return A new observable with the Operator applied.
44
37
  * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.
45
38
  * If you have implemented an operator using `lift`, it is recommended that you create an
46
39
  * operator by simply returning `new Observable()` directly. See "Creating new operators from
@@ -90,9 +83,9 @@ export declare class Observable<T> implements Subscribable<T> {
90
83
  * // 'Total: 6'
91
84
  * ```
92
85
  *
93
- * @param next a handler for each value emitted by the observable
94
- * @return a promise that either resolves on observable completion or
95
- * rejects with the handled error
86
+ * @param next A handler for each value emitted by the observable.
87
+ * @return A promise that either resolves on observable completion or
88
+ * rejects with the handled error.
96
89
  */
97
90
  forEach(next: (value: T) => void): Promise<void>;
98
91
  /**
@@ -37,9 +37,9 @@ export declare class ReplaySubject<T> extends Subject<T> {
37
37
  private _buffer;
38
38
  private _infiniteTimeWindow;
39
39
  /**
40
- * @param bufferSize The size of the buffer to replay on subscription
41
- * @param windowTime The amount of time the buffered items will stay buffered
42
- * @param timestampProvider An object with a `now()` method that provides the current timestamp. This is used to
40
+ * @param _bufferSize The size of the buffer to replay on subscription
41
+ * @param _windowTime The amount of time the buffered items will stay buffered
42
+ * @param _timestampProvider An object with a `now()` method that provides the current timestamp. This is used to
43
43
  * calculate the amount of time something has been buffered.
44
44
  */
45
45
  constructor(_bufferSize?: number, _windowTime?: number, _timestampProvider?: TimestampProvider);
@@ -15,7 +15,6 @@ import { SchedulerLike, SchedulerAction } from './types';
15
15
  * }
16
16
  * ```
17
17
  *
18
- * @class Scheduler
19
18
  * @deprecated Scheduler is an internal implementation detail of RxJS, and
20
19
  * should not be used directly. Rather, create your own class and implement
21
20
  * {@link SchedulerLike}. Will be made internal in v8.
@@ -28,7 +27,7 @@ export declare class Scheduler implements SchedulerLike {
28
27
  * A getter method that returns a number representing the current time
29
28
  * (at the time this function was called) according to the scheduler's own
30
29
  * internal clock.
31
- * @return {number} A number that represents the current time. May or may not
30
+ * @return A number that represents the current time. May or may not
32
31
  * have a relation to wall-clock time. May or may not refer to a time unit
33
32
  * (e.g. milliseconds).
34
33
  */
@@ -41,14 +40,13 @@ export declare class Scheduler implements SchedulerLike {
41
40
  * The given arguments will be processed an stored as an Action object in a
42
41
  * queue of actions.
43
42
  *
44
- * @param {function(state: ?T): ?Subscription} work A function representing a
45
- * task, or some unit of work to be executed by the Scheduler.
46
- * @param {number} [delay] Time to wait before executing the work, where the
47
- * time unit is implicit and defined by the Scheduler itself.
48
- * @param {T} [state] Some contextual data that the `work` function uses when
49
- * called by the Scheduler.
50
- * @return {Subscription} A subscription in order to be able to unsubscribe
51
- * the scheduled work.
43
+ * @param work A function representing a task, or some unit of work to be
44
+ * executed by the Scheduler.
45
+ * @param delay Time to wait before executing the work, where the time unit is
46
+ * implicit and defined by the Scheduler itself.
47
+ * @param state Some contextual data that the `work` function uses when called
48
+ * by the Scheduler.
49
+ * @return A subscription in order to be able to unsubscribe the scheduled work.
52
50
  */
53
51
  schedule<T>(work: (this: SchedulerAction<T>, state?: T) => void, delay?: number, state?: T): Subscription;
54
52
  }
@@ -22,7 +22,6 @@ export declare class Subject<T> extends Observable<T> implements SubscriptionLik
22
22
  /**
23
23
  * Creates a "subject" by basically gluing an observer to an observable.
24
24
  *
25
- * @nocollapse
26
25
  * @deprecated Recommended you do not use. Will be removed at some point in the future. Plans for replacement still under discussion.
27
26
  */
28
27
  static create: (...args: any[]) => any;
@@ -38,13 +37,10 @@ export declare class Subject<T> extends Observable<T> implements SubscriptionLik
38
37
  * Creates a new Observable with this Subject as the source. You can do this
39
38
  * to create custom Observer-side logic of the Subject and conceal it from
40
39
  * code that uses the Observable.
41
- * @return {Observable} Observable that the Subject casts to
40
+ * @return Observable that this Subject casts to.
42
41
  */
43
42
  asObservable(): Observable<T>;
44
43
  }
45
- /**
46
- * @class AnonymousSubject<T>
47
- */
48
44
  export declare class AnonymousSubject<T> extends Subject<T> {
49
45
  /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */
50
46
  destination?: Observer<T> | undefined;
@@ -7,8 +7,6 @@ import { Subscription } from './Subscription';
7
7
  * a Subscriber, in order to provide Subscription-like capabilities such as
8
8
  * `unsubscribe`. Subscriber is a common type in RxJS, and crucial for
9
9
  * implementing operators, but it is rarely used as a public API.
10
- *
11
- * @class Subscriber<T>
12
10
  */
13
11
  export declare class Subscriber<T> extends Subscription implements Observer<T> {
14
12
  /**
@@ -21,7 +19,6 @@ export declare class Subscriber<T> extends Subscription implements Observer<T> {
21
19
  * Observer.
22
20
  * @return A Subscriber wrapping the (partially defined)
23
21
  * Observer represented by the given arguments.
24
- * @nocollapse
25
22
  * @deprecated Do not use. Will be removed in v8. There is no replacement for this
26
23
  * method, and there is no reason to be creating instances of `Subscriber` directly.
27
24
  * If you have a specific use case, please file an issue.
@@ -40,23 +37,20 @@ export declare class Subscriber<T> extends Subscription implements Observer<T> {
40
37
  * The {@link Observer} callback to receive notifications of type `next` from
41
38
  * the Observable, with a value. The Observable may call this method 0 or more
42
39
  * times.
43
- * @param {T} [value] The `next` value.
44
- * @return {void}
40
+ * @param value The `next` value.
45
41
  */
46
- next(value?: T): void;
42
+ next(value: T): void;
47
43
  /**
48
44
  * The {@link Observer} callback to receive notifications of type `error` from
49
45
  * the Observable, with an attached `Error`. Notifies the Observer that
50
46
  * the Observable has experienced an error condition.
51
- * @param {any} [err] The `error` exception.
52
- * @return {void}
47
+ * @param err The `error` exception.
53
48
  */
54
49
  error(err?: any): void;
55
50
  /**
56
51
  * The {@link Observer} callback to receive a valueless notification of type
57
52
  * `complete` from the Observable. Notifies the Observer that the Observable
58
53
  * has finished sending push-based notifications.
59
- * @return {void}
60
54
  */
61
55
  complete(): void;
62
56
  unsubscribe(): void;
@@ -8,12 +8,9 @@ import { SubscriptionLike, TeardownLogic } from './types';
8
8
  * method, which will attach a child Subscription to the current Subscription.
9
9
  * When a Subscription is unsubscribed, all its children (and its grandchildren)
10
10
  * will be unsubscribed as well.
11
- *
12
- * @class Subscription
13
11
  */
14
12
  export declare class Subscription implements SubscriptionLike {
15
13
  private initialTeardown?;
16
- /** @nocollapse */
17
14
  static EMPTY: Subscription;
18
15
  /**
19
16
  * A flag to indicate whether this Subscription has already been unsubscribed.
@@ -34,7 +31,6 @@ export declare class Subscription implements SubscriptionLike {
34
31
  * Disposes the resources held by the subscription. May, for instance, cancel
35
32
  * an ongoing Observable execution or cancel any other type of work that
36
33
  * started when the Subscription was created.
37
- * @return {void}
38
34
  */
39
35
  unsubscribe(): void;
40
36
  /**
@@ -41,12 +41,11 @@ import { ObservedValueOf, ObservableInput } from '../types';
41
41
  *
42
42
  * @see {@link Observable}
43
43
  *
44
- * @param {function(): ObservableInput} observableFactory The Observable
45
- * factory function to invoke for each Observer that subscribes to the output
46
- * Observable. May also return a Promise, which will be converted on the fly
47
- * to an Observable.
48
- * @return {Observable} An Observable whose Observers' subscriptions trigger
49
- * an invocation of the given Observable factory function.
44
+ * @param observableFactory The Observable factory function to invoke for each
45
+ * Observer that subscribes to the output Observable. May also return any
46
+ * `ObservableInput`, which will be converted on the fly to an Observable.
47
+ * @return An Observable whose Observers' subscriptions trigger an invocation of the
48
+ * given Observable factory function.
50
49
  */
51
50
  export declare function defer<R extends ObservableInput<any>>(observableFactory: () => R): Observable<ObservedValueOf<R>>;
52
51
  //# sourceMappingURL=defer.d.ts.map
@@ -72,13 +72,15 @@ export interface GenerateOptions<T, S> extends GenerateBaseOptions<S> {
72
72
  * @see {@link from}
73
73
  * @see {@link Observable}
74
74
  *
75
- * @param {S} initialState Initial state.
76
- * @param {function (state: S): boolean} condition Condition to terminate generation (upon returning false).
77
- * @param {function (state: S): S} iterate Iteration step function.
78
- * @param {function (state: S): T} resultSelector Selector function for results produced in the sequence. (deprecated)
79
- * @param {SchedulerLike} [scheduler] A {@link SchedulerLike} on which to run the generator loop. If not provided, defaults to emit immediately.
80
- * @returns {Observable<T>} The generated sequence.
81
- * @deprecated Instead of passing separate arguments, use the options argument. Signatures taking separate arguments will be removed in v8.
75
+ * @param initialState Initial state.
76
+ * @param condition Condition to terminate generation (upon returning false).
77
+ * @param iterate Iteration step function.
78
+ * @param resultSelector Selector function for results produced in the sequence.
79
+ * @param scheduler A {@link SchedulerLike} on which to run the generator loop.
80
+ * If not provided, defaults to emit immediately.
81
+ * @returns The generated sequence.
82
+ * @deprecated Instead of passing separate arguments, use the options argument.
83
+ * Signatures taking separate arguments will be removed in v8.
82
84
  */
83
85
  export declare function generate<T, S>(initialState: S, condition: ConditionFunc<S>, iterate: IterateFunc<S>, resultSelector: ResultFunc<S, T>, scheduler?: SchedulerLike): Observable<T>;
84
86
  /**
@@ -215,13 +217,14 @@ export declare function generate<T, S>(initialState: S, condition: ConditionFunc
215
217
  *
216
218
  * @see {@link from}
217
219
  *
218
- * @param {S} initialState Initial state.
219
- * @param {function (state: S): boolean} condition Condition to terminate generation (upon returning false).
220
- * @param {function (state: S): S} iterate Iteration step function.
221
- * @param {function (state: S): T} [resultSelector] Selector function for results produced in the sequence.
222
- * @param {Scheduler} [scheduler] A {@link Scheduler} on which to run the generator loop. If not provided, defaults to emitting immediately.
223
- * @return {Observable<T>} The generated sequence.
224
- * @deprecated Instead of passing separate arguments, use the options argument. Signatures taking separate arguments will be removed in v8.
220
+ * @param initialState Initial state.
221
+ * @param condition Condition to terminate generation (upon returning false).
222
+ * @param iterate Iteration step function.
223
+ * @param scheduler A {@link Scheduler} on which to run the generator loop. If not
224
+ * provided, defaults to emitting immediately.
225
+ * @return The generated sequence.
226
+ * @deprecated Instead of passing separate arguments, use the options argument.
227
+ * Signatures taking separate arguments will be removed in v8.
225
228
  */
226
229
  export declare function generate<S>(initialState: S, condition: ConditionFunc<S>, iterate: IterateFunc<S>, scheduler?: SchedulerLike): Observable<S>;
227
230
  /**
@@ -261,8 +264,8 @@ export declare function generate<S>(initialState: S, condition: ConditionFunc<S>
261
264
  * @see {@link from}
262
265
  * @see {@link Observable}
263
266
  *
264
- * @param {GenerateBaseOptions<S>} options Object that must contain initialState, iterate and might contain condition and scheduler.
265
- * @returns {Observable<S>} The generated sequence.
267
+ * @param options Object that must contain initialState, iterate and might contain condition and scheduler.
268
+ * @returns The generated sequence.
266
269
  */
267
270
  export declare function generate<S>(options: GenerateBaseOptions<S>): Observable<S>;
268
271
  /**
@@ -303,8 +306,8 @@ export declare function generate<S>(options: GenerateBaseOptions<S>): Observable
303
306
  * @see {@link from}
304
307
  * @see {@link Observable}
305
308
  *
306
- * @param {GenerateOptions<T, S>} options Object that must contain initialState, iterate, resultSelector and might contain condition and scheduler.
307
- * @returns {Observable<T>} The generated sequence.
309
+ * @param options Object that must contain initialState, iterate, resultSelector and might contain condition and scheduler.
310
+ * @returns The generated sequence.
308
311
  */
309
312
  export declare function generate<T, S>(options: GenerateOptions<T, S>): Observable<T>;
310
313
  export {};
@@ -38,12 +38,11 @@ import { SchedulerLike } from '../types';
38
38
  * @see {@link timer}
39
39
  * @see {@link delay}
40
40
  *
41
- * @param {number} [period=0] The interval size in milliseconds (by default)
42
- * or the time unit determined by the scheduler's clock.
43
- * @param {SchedulerLike} [scheduler=async] The {@link SchedulerLike} to use for scheduling
44
- * the emission of values, and providing a notion of "time".
45
- * @return {Observable} An Observable that emits a sequential number each time
46
- * interval.
41
+ * @param period The interval size in milliseconds (by default) or the time unit determined
42
+ * by the scheduler's clock.
43
+ * @param scheduler The {@link SchedulerLike} to use for scheduling the emission of values,
44
+ * and providing a notion of "time".
45
+ * @return An Observable that emits a sequential number each time interval.
47
46
  */
48
47
  export declare function interval(period?: number, scheduler?: SchedulerLike): Observable<number>;
49
48
  //# sourceMappingURL=interval.d.ts.map
@@ -21,11 +21,9 @@ import { Unsubscribable, ObservableInput, ObservedValueOf } from '../types';
21
21
  *
22
22
  * @see {@link defer}
23
23
  *
24
- * @param {function(): ISubscription} resourceFactory A function which creates any resource object
25
- * that implements `unsubscribe` method.
26
- * @param {function(resource: ISubscription): Observable<T>} observableFactory A function which
27
- * creates an Observable, that can use injected resource object.
28
- * @return {Observable<T>} An Observable that behaves the same as Observable returned by `observableFactory`, but
24
+ * @param resourceFactory A function which creates any resource object that implements `unsubscribe` method.
25
+ * @param observableFactory A function which creates an Observable, that can use injected resource object.
26
+ * @return An Observable that behaves the same as Observable returned by `observableFactory`, but
29
27
  * which - when completed, errored or unsubscribed - will also call `unsubscribe` on created resource object.
30
28
  */
31
29
  export declare function using<T extends ObservableInput<any>>(resourceFactory: () => Unsubscribable | void, observableFactory: (resource: Unsubscribable | void) => T | void): Observable<ObservedValueOf<T>>;
@@ -38,11 +38,11 @@ import { MonoTypeOperatorFunction, SchedulerLike } from '../types';
38
38
  * @see {@link sampleTime}
39
39
  * @see {@link throttleTime}
40
40
  *
41
- * @param {number} duration Time to wait before emitting the most recent source
42
- * value, measured in milliseconds or the time unit determined internally
43
- * by the optional `scheduler`.
44
- * @param {SchedulerLike} [scheduler=async] The {@link SchedulerLike} to use for
45
- * managing the timers that handle the rate-limiting behavior.
41
+ * @param duration Time to wait before emitting the most recent source value,
42
+ * measured in milliseconds or the time unit determined internally by the
43
+ * optional `scheduler`.
44
+ * @param scheduler The {@link SchedulerLike} to use for managing the timers
45
+ * that handle the rate-limiting behavior.
46
46
  * @return A function that returns an Observable that performs rate-limiting of
47
47
  * emissions from the source Observable.
48
48
  */
@@ -43,8 +43,8 @@ import { OperatorFunction } from '../types';
43
43
  * @see {@link pairwise}
44
44
  * @see {@link windowCount}
45
45
  *
46
- * @param {number} bufferSize The maximum size of the buffer emitted.
47
- * @param {number} [startBufferEvery] Interval at which to start a new buffer.
46
+ * @param bufferSize The maximum size of the buffer emitted.
47
+ * @param startBufferEvery Interval at which to start a new buffer.
48
48
  * For example if `startBufferEvery` is `2`, then a new buffer will be started
49
49
  * on every other value from the source. A new buffer is started at the
50
50
  * beginning of the source by default.
@@ -33,8 +33,8 @@ import { ObservableInput, OperatorFunction } from '../types';
33
33
  * @see {@link bufferToggle}
34
34
  * @see {@link windowWhen}
35
35
  *
36
- * @param {function(): Observable} closingSelector A function that takes no
37
- * arguments and returns an Observable that signals buffer closure.
36
+ * @param closingSelector A function that takes no arguments and returns an
37
+ * Observable that signals buffer closure.
38
38
  * @return A function that returns an Observable of arrays of buffered values.
39
39
  */
40
40
  export declare function bufferWhen<T>(closingSelector: () => ObservableInput<any>): OperatorFunction<T, T[]>;
@@ -46,12 +46,11 @@ import { MonoTypeOperatorFunction, SchedulerLike } from '../types';
46
46
  * @see {@link throttle}
47
47
  * @see {@link throttleTime}
48
48
  *
49
- * @param {number} dueTime The timeout duration in milliseconds (or the time
50
- * unit determined internally by the optional `scheduler`) for the window of
51
- * time required to wait for emission silence before emitting the most recent
52
- * source value.
53
- * @param {SchedulerLike} [scheduler=async] The {@link SchedulerLike} to use for
54
- * managing the timers that handle the timeout for each value.
49
+ * @param dueTime The timeout duration in milliseconds (or the time unit determined
50
+ * internally by the optional `scheduler`) for the window of time required to wait
51
+ * for emission silence before emitting the most recent source value.
52
+ * @param scheduler The {@link SchedulerLike} to use for managing the timers that
53
+ * handle the timeout for each value.
55
54
  * @return A function that returns an Observable that delays the emissions of
56
55
  * the source Observable by the specified `dueTime`, and may drop some values
57
56
  * if they occur too frequently.
@@ -48,10 +48,10 @@ import { MonoTypeOperatorFunction, SchedulerLike } from '../types';
48
48
  * @see {@link audit}
49
49
  * @see {@link auditTime}
50
50
  *
51
- * @param {number|Date} due The delay duration in milliseconds (a `number`) or
52
- * a `Date` until which the emission of the source items is delayed.
53
- * @param {SchedulerLike} [scheduler=async] The {@link SchedulerLike} to use for
54
- * managing the timers that handle the time-shift for each item.
51
+ * @param due The delay duration in milliseconds (a `number`) or a `Date` until
52
+ * which the emission of the source items is delayed.
53
+ * @param scheduler The {@link SchedulerLike} to use for managing the timers
54
+ * that handle the time-shift for each item.
55
55
  * @return A function that returns an Observable that delays the emissions of
56
56
  * the source Observable by the specified timeout or Date.
57
57
  */
@@ -37,12 +37,12 @@ import { OperatorFunction } from '../types';
37
37
  * @see {@link take}
38
38
  *
39
39
  * @throws {ArgumentOutOfRangeError} When using `elementAt(i)`, it delivers an
40
- * ArgumentOutOfRangeError to the Observer's `error` callback if `i < 0` or the
40
+ * `ArgumentOutOfRangeError` to the Observer's `error` callback if `i < 0` or the
41
41
  * Observable has completed before emitting the i-th `next` notification.
42
42
  *
43
- * @param {number} index Is the number `i` for the i-th source emission that has
44
- * happened since the subscription, starting from the number `0`.
45
- * @param {T} [defaultValue] The default value returned for missing indices.
43
+ * @param index Is the number `i` for the i-th source emission that has happened
44
+ * since the subscription, starting from the number `0`.
45
+ * @param defaultValue The default value returned for missing indices.
46
46
  * @return A function that returns an Observable that emits a single item, if
47
47
  * it is found. Otherwise, it will emit the default value if given. If not, it
48
48
  * emits an error.
@@ -56,7 +56,7 @@ import { MonoTypeOperatorFunction } from '../types';
56
56
  * // '[finalize] Called'
57
57
  * ```
58
58
  *
59
- * @param {function} callback Function to be called when source terminates.
59
+ * @param callback Function to be called when source terminates.
60
60
  * @return A function that returns an Observable that mirrors the source, but
61
61
  * will call the specified function on termination.
62
62
  */
@@ -1,7 +1,8 @@
1
1
  import { MonoTypeOperatorFunction } from '../types';
2
2
  /**
3
- * The Max operator operates on an Observable that emits numbers (or items that can be compared with a provided function),
4
- * and when source Observable completes it emits a single item: the item with the largest value.
3
+ * The `max` operator operates on an Observable that emits numbers (or items that
4
+ * can be compared with a provided function), and when source Observable completes
5
+ * it emits a single item: the item with the largest value.
5
6
  *
6
7
  * ![](max.png)
7
8
  *
@@ -40,8 +41,8 @@ import { MonoTypeOperatorFunction } from '../types';
40
41
  *
41
42
  * @see {@link min}
42
43
  *
43
- * @param {Function} [comparer] - Optional comparer function that it will use instead of its default to compare the
44
- * value of two items.
44
+ * @param comparer Optional comparer function that it will use instead of its
45
+ * default to compare the value of two items.
45
46
  * @return A function that returns an Observable that emits item with the
46
47
  * largest value.
47
48
  */
@@ -53,8 +53,8 @@ import { OperatorFunction, ObservableInput, ObservedValueOf } from '../types';
53
53
  * @see {@link switchMap}
54
54
  * @see {@link zipAll}
55
55
  *
56
- * @param {number} [concurrent=Infinity] Maximum number of inner
57
- * Observables being subscribed to concurrently.
56
+ * @param concurrent Maximum number of inner Observables being subscribed to
57
+ * concurrently.
58
58
  * @return A function that returns an Observable that emits values coming from
59
59
  * all the inner Observables emitted by the source Observable.
60
60
  */
@@ -58,11 +58,10 @@ import { ObservableInput, OperatorFunction } from '../types';
58
58
  * @see {@link scan}
59
59
  * @see {@link switchScan}
60
60
  *
61
- * @param {function(acc: R, value: T): Observable<R>} accumulator
62
- * The accumulator function called on each source value.
61
+ * @param accumulator The accumulator function called on each source value.
63
62
  * @param seed The initial accumulation value.
64
- * @param {number} [concurrent=Infinity] Maximum number of
65
- * input Observables being subscribed to concurrently.
63
+ * @param concurrent Maximum number of input Observables being subscribed to
64
+ * concurrently.
66
65
  * @return A function that returns an Observable of the accumulated values.
67
66
  */
68
67
  export declare function mergeScan<T, R>(accumulator: (acc: R, value: T, index: number) => ObservableInput<R>, seed: R, concurrent?: number): OperatorFunction<T, R>;
@@ -1,7 +1,8 @@
1
1
  import { MonoTypeOperatorFunction } from '../types';
2
2
  /**
3
- * The Min operator operates on an Observable that emits numbers (or items that can be compared with a provided function),
4
- * and when source Observable completes it emits a single item: the item with the smallest value.
3
+ * The `min` operator operates on an Observable that emits numbers (or items that
4
+ * can be compared with a provided function), and when source Observable completes
5
+ * it emits a single item: the item with the smallest value.
5
6
  *
6
7
  * ![](min.png)
7
8
  *
@@ -40,8 +41,8 @@ import { MonoTypeOperatorFunction } from '../types';
40
41
  *
41
42
  * @see {@link max}
42
43
  *
43
- * @param {Function} [comparer] - Optional comparer function that it will use instead of its default to compare the
44
- * value of two items.
44
+ * @param comparer Optional comparer function that it will use instead of its
45
+ * default to compare the value of two items.
45
46
  * @return A function that returns an Observable that emits item with the
46
47
  * smallest value.
47
48
  */
@@ -101,8 +101,8 @@ export interface RepeatConfig {
101
101
  * @see {@link repeatWhen}
102
102
  * @see {@link retry}
103
103
  *
104
- * @param count The number of times the source Observable items are repeated, a count of 0 will yield
105
- * an empty Observable.
104
+ * @param countOrConfig Either the number of times the source Observable items are repeated
105
+ * (a count of 0 will yield an empty Observable) or a {@link RepeatConfig} object.
106
106
  */
107
107
  export declare function repeat<T>(countOrConfig?: number | RepeatConfig): MonoTypeOperatorFunction<T>;
108
108
  //# sourceMappingURL=repeat.d.ts.map
@@ -29,7 +29,7 @@ import { MonoTypeOperatorFunction, ObservableInput } from '../types';
29
29
  *
30
30
  * @param notifier Function that receives an Observable of notifications with
31
31
  * which a user can `complete` or `error`, aborting the repetition.
32
- * @return A function that returns an `ObservableInput` that mirrors the source
32
+ * @return A function that returns an Observable that mirrors the source
33
33
  * Observable with the exception of a `complete`.
34
34
  * @deprecated Will be removed in v9 or v10. Use {@link repeat}'s {@link RepeatConfig#delay delay} option instead.
35
35
  * Instead of `repeatWhen(() => notify$)`, use: `repeat({ delay: () => notify$ })`.
@@ -51,7 +51,7 @@ import { MonoTypeOperatorFunction, ObservableInput } from '../types';
51
51
  *
52
52
  * @param notifier Function that receives an Observable of notifications with which a
53
53
  * user can `complete` or `error`, aborting the retry.
54
- * @return A function that returns an `ObservableInput` that mirrors the source
54
+ * @return A function that returns an Observable that mirrors the source
55
55
  * Observable with the exception of an `error`.
56
56
  * @deprecated Will be removed in v9 or v10, use {@link retry}'s `delay` option instead.
57
57
  * Will be removed in v9 or v10. Use {@link retry}'s {@link RetryConfig#delay delay} option instead.