@runopencode/rx-stencil 0.4.0

package/dist/types/rx/decorator/query-selector.d.ts

@@ -0,0 +1,30 @@
+import { Observable } from 'rxjs';
+/**
+ * Options for QuerySelector decorator.
+ */
+export type QuerySelectorOptions = {
+  /**
+   * If `true`, the element will be searched in the shadow root. Default is `false`.
+   */
+  shadowRoot?: boolean;
+  /**
+   * If `true`, mutation observer instead of `renderObservable` from this package will
+   * be used to detect changes. Default is `false`.
+   */
+  mutationObserver?: boolean;
+};
+/**
+ * Observe all sub nodes of the given node and notify
+ * when any of them is removed and/or added.
+ *
+ * {@internal}
+ */
+export declare function observeSubNodes(target: Node): Observable<void>;
+/**
+ * Property decorator inspired by Angular's @ViewChild/@ContentChild.
+ *
+ * After each render, the decorated property will be set to the first element
+ * matching the given selector. If no element is found, the property will be
+ * set to null.
+ */
+export declare function QuerySelector<T extends HTMLElement = HTMLElement>(selector: string, options?: QuerySelectorOptions): any;

package/dist/types/rx/index.d.ts

@@ -0,0 +1,4 @@
+export * from './decorator';
+export * from './observable';
+export * from './operator';
+export * from './subscriber';

package/dist/types/rx/observable/index.d.ts

@@ -0,0 +1,3 @@
+export { mutationObservable } from './mutation-observable';
+export { propertyObservable } from './property-observable';
+export { renderObservable } from './render-observable';

package/dist/types/rx/observable/mutation-observable.d.ts

@@ -0,0 +1,2 @@
+import { Observable } from 'rxjs';
+export declare function mutationObservable(target: Node, options?: MutationObserverInit): Observable<MutationRecord[]>;

package/dist/types/rx/observable/property-observable.d.ts

@@ -0,0 +1,6 @@
+import { ComponentInterface } from '../../stencil-public-runtime';
+import { Observable } from 'rxjs';
+/**
+ * Returns an observable that emits property value when the component property value changes.
+ */
+export declare function propertyObservable<T = any>(cmp: ComponentInterface, property: string): Observable<T>;

package/dist/types/rx/observable/render-observable.d.ts

@@ -0,0 +1,8 @@
+import { ComponentInterface } from '../../stencil-public-runtime';
+import { Observable } from 'rxjs';
+/**
+ * Returns an observable that emits when the component render()
+ * function is called. Value will be emitted after the next
+ * microtask (next tick).
+ */
+export declare function renderObservable(cmp: ComponentInterface): Observable<void>;

package/dist/types/rx/operator/index.d.ts

@@ -0,0 +1,3 @@
+export { scheduleRender } from './schedule-render';
+export { toProperty } from './to-property';
+export { untilDisconnected } from './until-disconnected';

package/dist/types/rx/operator/schedule-render.d.ts

@@ -0,0 +1,12 @@
+import { ComponentInterface } from '../../stencil-public-runtime';
+import { MonoTypeOperatorFunction } from 'rxjs';
+/**
+ * Schedule a render of the component. This is useful when you
+ * want to force a render of the component as result of changing
+ * the values of the component which are not tracked by Stencil,
+ * observables, for example.
+ *
+ * By default, the render is scheduled on the next tick, but you
+ * can disable this behavior by passing `false` as second argument.
+ */
+export declare function scheduleRender<T = unknown>(cmp: ComponentInterface, nextTick?: boolean): MonoTypeOperatorFunction<T>;

package/dist/types/rx/operator/to-property.d.ts

@@ -0,0 +1,9 @@
+import { ComponentInterface } from '../../stencil-public-runtime';
+import { MonoTypeOperatorFunction } from 'rxjs';
+/**
+ * Use this function to tap into a value stream and flush value to
+ * component property. You may also use this function as subscription
+ * function (function will detect that value is passed instead of
+ * observable).
+ */
+export declare function toProperty<T = any>(cmp: ComponentInterface, property: string): MonoTypeOperatorFunction<T>;

package/dist/types/rx/operator/until-disconnected.d.ts

@@ -0,0 +1,7 @@
+import { ComponentInterface } from '../../stencil-public-runtime';
+import { MonoTypeOperatorFunction } from 'rxjs';
+/**
+ * Operator that unsubscribes from the source observable when
+ * the component is disconnected from DOM.
+ */
+export declare function untilDisconnected<T = unknown>(cmp: ComponentInterface): MonoTypeOperatorFunction<T>;

package/dist/types/rx/subscriber/index.d.ts

@@ -0,0 +1 @@
+export { SetPropertyOptions, setProperty, } from './set-property';

package/dist/types/rx/subscriber/set-property.d.ts

@@ -0,0 +1,16 @@
+import { ComponentInterface } from '../../stencil-public-runtime';
+export type SetPropertyOptions = {
+  /**
+   * Whether to schedule a render of the component after the
+   * property is updated. By default, this value is set to
+   * `false`, assuming that the property is annotated with
+   * either @State or @Prop decorator.
+   */
+  scheduleRender?: boolean;
+  /**
+   * Whether to schedule a render of the component on the next
+   * tick. By default, this value is set to `true`.
+   */
+  nextTick?: boolean;
+};
+export declare function setProperty<T = any>(cmp: ComponentInterface, property: string, options?: SetPropertyOptions): (value: T) => void;