std-react-bindings 0.0.1
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.
- package/LICENSE +19 -0
- package/README.md +146 -0
- package/lib/bc/bc.d.ts +7 -0
- package/lib/bc/bc.d.ts.map +1 -0
- package/lib/bc/exports.d.ts +2 -0
- package/lib/bc/exports.d.ts.map +1 -0
- package/lib/binding/exports.d.ts +4 -0
- package/lib/binding/exports.d.ts.map +1 -0
- package/lib/binding/internal/DoubleLinkedList/index.d.ts +25 -0
- package/lib/binding/internal/DoubleLinkedList/index.d.ts.map +1 -0
- package/lib/binding/internal/binding-impl.d.ts +60 -0
- package/lib/binding/internal/binding-impl.d.ts.map +1 -0
- package/lib/binding/internal/consts.d.ts +3 -0
- package/lib/binding/internal/consts.d.ts.map +1 -0
- package/lib/binding/make-binding.d.ts +7 -0
- package/lib/binding/make-binding.d.ts.map +1 -0
- package/lib/binding/types/binding-args.d.ts +44 -0
- package/lib/binding/types/binding-args.d.ts.map +1 -0
- package/lib/binding/types/binding-dependencies.d.ts +5 -0
- package/lib/binding/types/binding-dependencies.d.ts.map +1 -0
- package/lib/binding/types/binding-initializer.d.ts +3 -0
- package/lib/binding/types/binding-initializer.d.ts.map +1 -0
- package/lib/binding/types/binding.d.ts +22 -0
- package/lib/binding/types/binding.d.ts.map +1 -0
- package/lib/binding/types/change-listener.d.ts +5 -0
- package/lib/binding/types/change-listener.d.ts.map +1 -0
- package/lib/binding/types/exports.d.ts +12 -0
- package/lib/binding/types/exports.d.ts.map +1 -0
- package/lib/binding/types/infer-binding-value-types.d.ts +8 -0
- package/lib/binding/types/infer-binding-value-types.d.ts.map +1 -0
- package/lib/binding/types/infer-bindings-array-value-types.d.ts +8 -0
- package/lib/binding/types/infer-bindings-array-value-types.d.ts.map +1 -0
- package/lib/binding/types/infer-named-binding-value-types.d.ts +8 -0
- package/lib/binding/types/infer-named-binding-value-types.d.ts.map +1 -0
- package/lib/binding/types/inference.d.ts +4 -0
- package/lib/binding/types/inference.d.ts.map +1 -0
- package/lib/binding/types/readonly-binding.d.ts +35 -0
- package/lib/binding/types/readonly-binding.d.ts.map +1 -0
- package/lib/binding/types/set-value-transformer.d.ts +11 -0
- package/lib/binding/types/set-value-transformer.d.ts.map +1 -0
- package/lib/binding/use-binding.d.ts +7 -0
- package/lib/binding/use-binding.d.ts.map +1 -0
- package/lib/binding-utils/exports.d.ts +4 -0
- package/lib/binding-utils/exports.d.ts.map +1 -0
- package/lib/binding-utils/internal/make-value-then-do.d.ts +6 -0
- package/lib/binding-utils/internal/make-value-then-do.d.ts.map +1 -0
- package/lib/binding-utils/lock-utils.d.ts +27 -0
- package/lib/binding-utils/lock-utils.d.ts.map +1 -0
- package/lib/binding-utils/modified-utils.d.ts +18 -0
- package/lib/binding-utils/modified-utils.d.ts.map +1 -0
- package/lib/binding-utils/type-utils.d.ts +6 -0
- package/lib/binding-utils/type-utils.d.ts.map +1 -0
- package/lib/cjs/bc/bc.js +13 -0
- package/lib/cjs/bc/bc.js.map +1 -0
- package/lib/cjs/bc/exports.js +18 -0
- package/lib/cjs/bc/exports.js.map +1 -0
- package/lib/cjs/binding/exports.js +20 -0
- package/lib/cjs/binding/exports.js.map +1 -0
- package/lib/cjs/binding/internal/DoubleLinkedList/index.js +110 -0
- package/lib/cjs/binding/internal/DoubleLinkedList/index.js.map +1 -0
- package/lib/cjs/binding/internal/binding-impl.js +181 -0
- package/lib/cjs/binding/internal/binding-impl.js.map +1 -0
- package/lib/cjs/binding/internal/consts.js +6 -0
- package/lib/cjs/binding/internal/consts.js.map +1 -0
- package/lib/cjs/binding/make-binding.js +22 -0
- package/lib/cjs/binding/make-binding.js.map +1 -0
- package/lib/cjs/binding/types/binding-args.js +3 -0
- package/lib/cjs/binding/types/binding-args.js.map +1 -0
- package/lib/cjs/binding/types/binding-dependencies.js +3 -0
- package/lib/cjs/binding/types/binding-dependencies.js.map +1 -0
- package/lib/cjs/binding/types/binding-initializer.js +3 -0
- package/lib/cjs/binding/types/binding-initializer.js.map +1 -0
- package/lib/cjs/binding/types/binding.js +3 -0
- package/lib/cjs/binding/types/binding.js.map +1 -0
- package/lib/cjs/binding/types/change-listener.js +3 -0
- package/lib/cjs/binding/types/change-listener.js.map +1 -0
- package/lib/cjs/binding/types/exports.js +28 -0
- package/lib/cjs/binding/types/exports.js.map +1 -0
- package/lib/cjs/binding/types/infer-binding-value-types.js +3 -0
- package/lib/cjs/binding/types/infer-binding-value-types.js.map +1 -0
- package/lib/cjs/binding/types/infer-bindings-array-value-types.js +3 -0
- package/lib/cjs/binding/types/infer-bindings-array-value-types.js.map +1 -0
- package/lib/cjs/binding/types/infer-named-binding-value-types.js +3 -0
- package/lib/cjs/binding/types/infer-named-binding-value-types.js.map +1 -0
- package/lib/cjs/binding/types/inference.js +3 -0
- package/lib/cjs/binding/types/inference.js.map +1 -0
- package/lib/cjs/binding/types/readonly-binding.js +3 -0
- package/lib/cjs/binding/types/readonly-binding.js.map +1 -0
- package/lib/cjs/binding/types/set-value-transformer.js +3 -0
- package/lib/cjs/binding/types/set-value-transformer.js.map +1 -0
- package/lib/cjs/binding/use-binding.js +10 -0
- package/lib/cjs/binding/use-binding.js.map +1 -0
- package/lib/cjs/binding-utils/exports.js +20 -0
- package/lib/cjs/binding-utils/exports.js.map +1 -0
- package/lib/cjs/binding-utils/internal/make-value-then-do.js +55 -0
- package/lib/cjs/binding-utils/internal/make-value-then-do.js.map +1 -0
- package/lib/cjs/binding-utils/lock-utils.js +51 -0
- package/lib/cjs/binding-utils/lock-utils.js.map +1 -0
- package/lib/cjs/binding-utils/modified-utils.js +33 -0
- package/lib/cjs/binding-utils/modified-utils.js.map +1 -0
- package/lib/cjs/binding-utils/type-utils.js +12 -0
- package/lib/cjs/binding-utils/type-utils.js.map +1 -0
- package/lib/cjs/components/BindingsConsumer/index.js +75 -0
- package/lib/cjs/components/BindingsConsumer/index.js.map +1 -0
- package/lib/cjs/components/BindingsConsumer/internal/Refreshable.js +48 -0
- package/lib/cjs/components/BindingsConsumer/internal/Refreshable.js.map +1 -0
- package/lib/cjs/components/BindingsConsumer/types/exports.js +19 -0
- package/lib/cjs/components/BindingsConsumer/types/exports.js.map +1 -0
- package/lib/cjs/components/BindingsConsumer/types/props.js +3 -0
- package/lib/cjs/components/BindingsConsumer/types/props.js.map +1 -0
- package/lib/cjs/components/BindingsConsumer/types/render-callback.js +3 -0
- package/lib/cjs/components/BindingsConsumer/types/render-callback.js.map +1 -0
- package/lib/cjs/components/exports.js +18 -0
- package/lib/cjs/components/exports.js.map +1 -0
- package/lib/cjs/config/are-equal.js +21 -0
- package/lib/cjs/config/are-equal.js.map +1 -0
- package/lib/cjs/config/exports.js +21 -0
- package/lib/cjs/config/exports.js.map +1 -0
- package/lib/cjs/config/logging.js +23 -0
- package/lib/cjs/config/logging.js.map +1 -0
- package/lib/cjs/config/stats-handler.js +14 -0
- package/lib/cjs/config/stats-handler.js.map +1 -0
- package/lib/cjs/default-queue/default-queue-context.js +63 -0
- package/lib/cjs/default-queue/default-queue-context.js.map +1 -0
- package/lib/cjs/default-queue/exports.js +18 -0
- package/lib/cjs/default-queue/exports.js.map +1 -0
- package/lib/cjs/index.js +31 -0
- package/lib/cjs/index.js.map +1 -0
- package/lib/cjs/internal-hooks/use-is-mounted-ref.js +17 -0
- package/lib/cjs/internal-hooks/use-is-mounted-ref.js.map +1 -0
- package/lib/cjs/internal-utils/array-like.js +32 -0
- package/lib/cjs/internal-utils/array-like.js.map +1 -0
- package/lib/cjs/internal-utils/extract-binding-dependency-values.js +34 -0
- package/lib/cjs/internal-utils/extract-binding-dependency-values.js.map +1 -0
- package/lib/cjs/internal-utils/get-typed-keys.js +11 -0
- package/lib/cjs/internal-utils/get-typed-keys.js.map +1 -0
- package/lib/cjs/internal-utils/uid.js +8 -0
- package/lib/cjs/internal-utils/uid.js.map +1 -0
- package/lib/cjs/limiter/exports.js +21 -0
- package/lib/cjs/limiter/exports.js.map +1 -0
- package/lib/cjs/limiter/internal/LimiterImpl.js +49 -0
- package/lib/cjs/limiter/internal/LimiterImpl.js.map +1 -0
- package/lib/cjs/limiter/make-limiter.js +8 -0
- package/lib/cjs/limiter/make-limiter.js.map +1 -0
- package/lib/cjs/limiter/pick-limiter-options.js +12 -0
- package/lib/cjs/limiter/pick-limiter-options.js.map +1 -0
- package/lib/cjs/limiter/types/LimitMode.js +3 -0
- package/lib/cjs/limiter/types/LimitMode.js.map +1 -0
- package/lib/cjs/limiter/types/LimitType.js +3 -0
- package/lib/cjs/limiter/types/LimitType.js.map +1 -0
- package/lib/cjs/limiter/types/Limiter.js +3 -0
- package/lib/cjs/limiter/types/Limiter.js.map +1 -0
- package/lib/cjs/limiter/types/LimiterOptions.js +3 -0
- package/lib/cjs/limiter/types/LimiterOptions.js.map +1 -0
- package/lib/cjs/limiter/types/exports.js +21 -0
- package/lib/cjs/limiter/types/exports.js.map +1 -0
- package/lib/cjs/limiter/use-limiter.js +26 -0
- package/lib/cjs/limiter/use-limiter.js.map +1 -0
- package/lib/cjs/make-bindable-component/exports.js +19 -0
- package/lib/cjs/make-bindable-component/exports.js.map +1 -0
- package/lib/cjs/make-bindable-component/make-bindable-component.js +43 -0
- package/lib/cjs/make-bindable-component/make-bindable-component.js.map +1 -0
- package/lib/cjs/make-bindable-component/types/exports.js +19 -0
- package/lib/cjs/make-bindable-component/types/exports.js.map +1 -0
- package/lib/cjs/make-bindable-component/types/make-bindable-component-options.js +3 -0
- package/lib/cjs/make-bindable-component/types/make-bindable-component-options.js.map +1 -0
- package/lib/cjs/make-bindable-component/types/upgrade-to-binding-props.js +3 -0
- package/lib/cjs/make-bindable-component/types/upgrade-to-binding-props.js.map +1 -0
- package/lib/cjs/resolveable/exports.js +19 -0
- package/lib/cjs/resolveable/exports.js.map +1 -0
- package/lib/cjs/resolveable/types.js +3 -0
- package/lib/cjs/resolveable/types.js.map +1 -0
- package/lib/cjs/resolveable/utils.js +17 -0
- package/lib/cjs/resolveable/utils.js.map +1 -0
- package/lib/cjs/specialized-bindings/const-binding.js +16 -0
- package/lib/cjs/specialized-bindings/const-binding.js.map +1 -0
- package/lib/cjs/specialized-bindings/derived-binding/exports.js +19 -0
- package/lib/cjs/specialized-bindings/derived-binding/exports.js.map +1 -0
- package/lib/cjs/specialized-bindings/derived-binding/options.js +3 -0
- package/lib/cjs/specialized-bindings/derived-binding/options.js.map +1 -0
- package/lib/cjs/specialized-bindings/derived-binding/use-derived-binding.js +44 -0
- package/lib/cjs/specialized-bindings/derived-binding/use-derived-binding.js.map +1 -0
- package/lib/cjs/specialized-bindings/exports.js +21 -0
- package/lib/cjs/specialized-bindings/exports.js.map +1 -0
- package/lib/cjs/specialized-bindings/flattened-binding.js +59 -0
- package/lib/cjs/specialized-bindings/flattened-binding.js.map +1 -0
- package/lib/cjs/specialized-bindings/transient-derived-binding/exports.js +20 -0
- package/lib/cjs/specialized-bindings/transient-derived-binding/exports.js.map +1 -0
- package/lib/cjs/specialized-bindings/transient-derived-binding/make-transient-derived-binding.js +53 -0
- package/lib/cjs/specialized-bindings/transient-derived-binding/make-transient-derived-binding.js.map +1 -0
- package/lib/cjs/specialized-bindings/transient-derived-binding/types/exports.js +18 -0
- package/lib/cjs/specialized-bindings/transient-derived-binding/types/exports.js.map +1 -0
- package/lib/cjs/specialized-bindings/transient-derived-binding/types/transient-derived-binding-args.js +3 -0
- package/lib/cjs/specialized-bindings/transient-derived-binding/types/transient-derived-binding-args.js.map +1 -0
- package/lib/cjs/specialized-bindings/transient-derived-binding/use-transient-derived-binding.js +18 -0
- package/lib/cjs/specialized-bindings/transient-derived-binding/use-transient-derived-binding.js.map +1 -0
- package/lib/cjs/synchronization/exports.js +20 -0
- package/lib/cjs/synchronization/exports.js.map +1 -0
- package/lib/cjs/synchronization/types/exports.js +18 -0
- package/lib/cjs/synchronization/types/exports.js.map +1 -0
- package/lib/cjs/synchronization/types/options.js +3 -0
- package/lib/cjs/synchronization/types/options.js.map +1 -0
- package/lib/cjs/synchronization/use-bi-dir-binding-sync.js +16 -0
- package/lib/cjs/synchronization/use-bi-dir-binding-sync.js.map +1 -0
- package/lib/cjs/synchronization/use-uni-dir-binding-sync.js +10 -0
- package/lib/cjs/synchronization/use-uni-dir-binding-sync.js.map +1 -0
- package/lib/cjs/types/array-like.js +3 -0
- package/lib/cjs/types/array-like.js.map +1 -0
- package/lib/cjs/types/empty.js +3 -0
- package/lib/cjs/types/empty.js.map +1 -0
- package/lib/cjs/types/exports.js +19 -0
- package/lib/cjs/types/exports.js.map +1 -0
- package/lib/cjs/use-binding-effect/exports.js +19 -0
- package/lib/cjs/use-binding-effect/exports.js.map +1 -0
- package/lib/cjs/use-binding-effect/types/exports.js +18 -0
- package/lib/cjs/use-binding-effect/types/exports.js.map +1 -0
- package/lib/cjs/use-binding-effect/types/options.js +3 -0
- package/lib/cjs/use-binding-effect/types/options.js.map +1 -0
- package/lib/cjs/use-binding-effect/use-binding-effect.js +145 -0
- package/lib/cjs/use-binding-effect/use-binding-effect.js.map +1 -0
- package/lib/cjs/utility-hooks/exports.js +19 -0
- package/lib/cjs/utility-hooks/exports.js.map +1 -0
- package/lib/cjs/utility-hooks/use-callback-ref.js +38 -0
- package/lib/cjs/utility-hooks/use-callback-ref.js.map +1 -0
- package/lib/cjs/utility-hooks/use-stable-value.js +18 -0
- package/lib/cjs/utility-hooks/use-stable-value.js.map +1 -0
- package/lib/components/BindingsConsumer/index.d.ts +27 -0
- package/lib/components/BindingsConsumer/index.d.ts.map +1 -0
- package/lib/components/BindingsConsumer/internal/Refreshable.d.ts +16 -0
- package/lib/components/BindingsConsumer/internal/Refreshable.d.ts.map +1 -0
- package/lib/components/BindingsConsumer/types/exports.d.ts +3 -0
- package/lib/components/BindingsConsumer/types/exports.d.ts.map +1 -0
- package/lib/components/BindingsConsumer/types/props.d.ts +29 -0
- package/lib/components/BindingsConsumer/types/props.d.ts.map +1 -0
- package/lib/components/BindingsConsumer/types/render-callback.d.ts +11 -0
- package/lib/components/BindingsConsumer/types/render-callback.d.ts.map +1 -0
- package/lib/components/exports.d.ts +2 -0
- package/lib/components/exports.d.ts.map +1 -0
- package/lib/config/are-equal.d.ts +7 -0
- package/lib/config/are-equal.d.ts.map +1 -0
- package/lib/config/exports.d.ts +4 -0
- package/lib/config/exports.d.ts.map +1 -0
- package/lib/config/logging.d.ts +17 -0
- package/lib/config/logging.d.ts.map +1 -0
- package/lib/config/stats-handler.d.ts +26 -0
- package/lib/config/stats-handler.d.ts.map +1 -0
- package/lib/default-queue/default-queue-context.d.ts +19 -0
- package/lib/default-queue/default-queue-context.d.ts.map +1 -0
- package/lib/default-queue/exports.d.ts +2 -0
- package/lib/default-queue/exports.d.ts.map +1 -0
- package/lib/index.d.ts +15 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/internal-hooks/use-is-mounted-ref.d.ts +4 -0
- package/lib/internal-hooks/use-is-mounted-ref.d.ts.map +1 -0
- package/lib/internal-utils/array-like.d.ts +11 -0
- package/lib/internal-utils/array-like.d.ts.map +1 -0
- package/lib/internal-utils/extract-binding-dependency-values.d.ts +7 -0
- package/lib/internal-utils/extract-binding-dependency-values.d.ts.map +1 -0
- package/lib/internal-utils/get-typed-keys.d.ts +7 -0
- package/lib/internal-utils/get-typed-keys.d.ts.map +1 -0
- package/lib/internal-utils/uid.d.ts +3 -0
- package/lib/internal-utils/uid.d.ts.map +1 -0
- package/lib/limiter/exports.d.ts +5 -0
- package/lib/limiter/exports.d.ts.map +1 -0
- package/lib/limiter/internal/LimiterImpl.d.ts +15 -0
- package/lib/limiter/internal/LimiterImpl.d.ts.map +1 -0
- package/lib/limiter/make-limiter.d.ts +9 -0
- package/lib/limiter/make-limiter.d.ts.map +1 -0
- package/lib/limiter/pick-limiter-options.d.ts +3 -0
- package/lib/limiter/pick-limiter-options.d.ts.map +1 -0
- package/lib/limiter/types/LimitMode.d.ts +7 -0
- package/lib/limiter/types/LimitMode.d.ts.map +1 -0
- package/lib/limiter/types/LimitType.d.ts +32 -0
- package/lib/limiter/types/LimitType.d.ts.map +1 -0
- package/lib/limiter/types/Limiter.d.ts +9 -0
- package/lib/limiter/types/Limiter.d.ts.map +1 -0
- package/lib/limiter/types/LimiterOptions.d.ts +36 -0
- package/lib/limiter/types/LimiterOptions.d.ts.map +1 -0
- package/lib/limiter/types/exports.d.ts +5 -0
- package/lib/limiter/types/exports.d.ts.map +1 -0
- package/lib/limiter/use-limiter.d.ts +14 -0
- package/lib/limiter/use-limiter.d.ts.map +1 -0
- package/lib/make-bindable-component/exports.d.ts +3 -0
- package/lib/make-bindable-component/exports.d.ts.map +1 -0
- package/lib/make-bindable-component/make-bindable-component.d.ts +16 -0
- package/lib/make-bindable-component/make-bindable-component.d.ts.map +1 -0
- package/lib/make-bindable-component/types/exports.d.ts +3 -0
- package/lib/make-bindable-component/types/exports.d.ts.map +1 -0
- package/lib/make-bindable-component/types/make-bindable-component-options.d.ts +6 -0
- package/lib/make-bindable-component/types/make-bindable-component-options.d.ts.map +1 -0
- package/lib/make-bindable-component/types/upgrade-to-binding-props.d.ts +5 -0
- package/lib/make-bindable-component/types/upgrade-to-binding-props.d.ts.map +1 -0
- package/lib/mjs/bc/bc.js +6 -0
- package/lib/mjs/bc/bc.js.map +1 -0
- package/lib/mjs/bc/exports.js +2 -0
- package/lib/mjs/bc/exports.js.map +1 -0
- package/lib/mjs/binding/exports.js +4 -0
- package/lib/mjs/binding/exports.js.map +1 -0
- package/lib/mjs/binding/internal/DoubleLinkedList/index.js +105 -0
- package/lib/mjs/binding/internal/DoubleLinkedList/index.js.map +1 -0
- package/lib/mjs/binding/internal/binding-impl.js +177 -0
- package/lib/mjs/binding/internal/binding-impl.js.map +1 -0
- package/lib/mjs/binding/internal/consts.js +3 -0
- package/lib/mjs/binding/internal/consts.js.map +1 -0
- package/lib/mjs/binding/make-binding.js +18 -0
- package/lib/mjs/binding/make-binding.js.map +1 -0
- package/lib/mjs/binding/types/binding-args.js +2 -0
- package/lib/mjs/binding/types/binding-args.js.map +1 -0
- package/lib/mjs/binding/types/binding-dependencies.js +2 -0
- package/lib/mjs/binding/types/binding-dependencies.js.map +1 -0
- package/lib/mjs/binding/types/binding-initializer.js +2 -0
- package/lib/mjs/binding/types/binding-initializer.js.map +1 -0
- package/lib/mjs/binding/types/binding.js +2 -0
- package/lib/mjs/binding/types/binding.js.map +1 -0
- package/lib/mjs/binding/types/change-listener.js +2 -0
- package/lib/mjs/binding/types/change-listener.js.map +1 -0
- package/lib/mjs/binding/types/exports.js +12 -0
- package/lib/mjs/binding/types/exports.js.map +1 -0
- package/lib/mjs/binding/types/infer-binding-value-types.js +2 -0
- package/lib/mjs/binding/types/infer-binding-value-types.js.map +1 -0
- package/lib/mjs/binding/types/infer-bindings-array-value-types.js +2 -0
- package/lib/mjs/binding/types/infer-bindings-array-value-types.js.map +1 -0
- package/lib/mjs/binding/types/infer-named-binding-value-types.js +2 -0
- package/lib/mjs/binding/types/infer-named-binding-value-types.js.map +1 -0
- package/lib/mjs/binding/types/inference.js +2 -0
- package/lib/mjs/binding/types/inference.js.map +1 -0
- package/lib/mjs/binding/types/readonly-binding.js +2 -0
- package/lib/mjs/binding/types/readonly-binding.js.map +1 -0
- package/lib/mjs/binding/types/set-value-transformer.js +2 -0
- package/lib/mjs/binding/types/set-value-transformer.js.map +1 -0
- package/lib/mjs/binding/use-binding.js +6 -0
- package/lib/mjs/binding/use-binding.js.map +1 -0
- package/lib/mjs/binding-utils/exports.js +4 -0
- package/lib/mjs/binding-utils/exports.js.map +1 -0
- package/lib/mjs/binding-utils/internal/make-value-then-do.js +48 -0
- package/lib/mjs/binding-utils/internal/make-value-then-do.js.map +1 -0
- package/lib/mjs/binding-utils/lock-utils.js +45 -0
- package/lib/mjs/binding-utils/lock-utils.js.map +1 -0
- package/lib/mjs/binding-utils/modified-utils.js +28 -0
- package/lib/mjs/binding-utils/modified-utils.js.map +1 -0
- package/lib/mjs/binding-utils/type-utils.js +7 -0
- package/lib/mjs/binding-utils/type-utils.js.map +1 -0
- package/lib/mjs/components/BindingsConsumer/index.js +45 -0
- package/lib/mjs/components/BindingsConsumer/index.js.map +1 -0
- package/lib/mjs/components/BindingsConsumer/internal/Refreshable.js +18 -0
- package/lib/mjs/components/BindingsConsumer/internal/Refreshable.js.map +1 -0
- package/lib/mjs/components/BindingsConsumer/types/exports.js +3 -0
- package/lib/mjs/components/BindingsConsumer/types/exports.js.map +1 -0
- package/lib/mjs/components/BindingsConsumer/types/props.js +2 -0
- package/lib/mjs/components/BindingsConsumer/types/props.js.map +1 -0
- package/lib/mjs/components/BindingsConsumer/types/render-callback.js +2 -0
- package/lib/mjs/components/BindingsConsumer/types/render-callback.js.map +1 -0
- package/lib/mjs/components/exports.js +2 -0
- package/lib/mjs/components/exports.js.map +1 -0
- package/lib/mjs/config/are-equal.js +12 -0
- package/lib/mjs/config/are-equal.js.map +1 -0
- package/lib/mjs/config/exports.js +5 -0
- package/lib/mjs/config/exports.js.map +1 -0
- package/lib/mjs/config/logging.js +16 -0
- package/lib/mjs/config/logging.js.map +1 -0
- package/lib/mjs/config/stats-handler.js +9 -0
- package/lib/mjs/config/stats-handler.js.map +1 -0
- package/lib/mjs/default-queue/default-queue-context.js +35 -0
- package/lib/mjs/default-queue/default-queue-context.js.map +1 -0
- package/lib/mjs/default-queue/exports.js +2 -0
- package/lib/mjs/default-queue/exports.js.map +1 -0
- package/lib/mjs/index.js +15 -0
- package/lib/mjs/index.js.map +1 -0
- package/lib/mjs/internal-hooks/use-is-mounted-ref.js +13 -0
- package/lib/mjs/internal-hooks/use-is-mounted-ref.js.map +1 -0
- package/lib/mjs/internal-utils/array-like.js +26 -0
- package/lib/mjs/internal-utils/array-like.js.map +1 -0
- package/lib/mjs/internal-utils/extract-binding-dependency-values.js +30 -0
- package/lib/mjs/internal-utils/extract-binding-dependency-values.js.map +1 -0
- package/lib/mjs/internal-utils/get-typed-keys.js +7 -0
- package/lib/mjs/internal-utils/get-typed-keys.js.map +1 -0
- package/lib/mjs/internal-utils/uid.js +4 -0
- package/lib/mjs/internal-utils/uid.js.map +1 -0
- package/lib/mjs/limiter/exports.js +5 -0
- package/lib/mjs/limiter/exports.js.map +1 -0
- package/lib/mjs/limiter/internal/LimiterImpl.js +42 -0
- package/lib/mjs/limiter/internal/LimiterImpl.js.map +1 -0
- package/lib/mjs/limiter/make-limiter.js +4 -0
- package/lib/mjs/limiter/make-limiter.js.map +1 -0
- package/lib/mjs/limiter/pick-limiter-options.js +8 -0
- package/lib/mjs/limiter/pick-limiter-options.js.map +1 -0
- package/lib/mjs/limiter/types/LimitMode.js +2 -0
- package/lib/mjs/limiter/types/LimitMode.js.map +1 -0
- package/lib/mjs/limiter/types/LimitType.js +2 -0
- package/lib/mjs/limiter/types/LimitType.js.map +1 -0
- package/lib/mjs/limiter/types/Limiter.js +2 -0
- package/lib/mjs/limiter/types/Limiter.js.map +1 -0
- package/lib/mjs/limiter/types/LimiterOptions.js +2 -0
- package/lib/mjs/limiter/types/LimiterOptions.js.map +1 -0
- package/lib/mjs/limiter/types/exports.js +5 -0
- package/lib/mjs/limiter/types/exports.js.map +1 -0
- package/lib/mjs/limiter/use-limiter.js +22 -0
- package/lib/mjs/limiter/use-limiter.js.map +1 -0
- package/lib/mjs/make-bindable-component/exports.js +3 -0
- package/lib/mjs/make-bindable-component/exports.js.map +1 -0
- package/lib/mjs/make-bindable-component/make-bindable-component.js +36 -0
- package/lib/mjs/make-bindable-component/make-bindable-component.js.map +1 -0
- package/lib/mjs/make-bindable-component/types/exports.js +3 -0
- package/lib/mjs/make-bindable-component/types/exports.js.map +1 -0
- package/lib/mjs/make-bindable-component/types/make-bindable-component-options.js +2 -0
- package/lib/mjs/make-bindable-component/types/make-bindable-component-options.js.map +1 -0
- package/lib/mjs/make-bindable-component/types/upgrade-to-binding-props.js +2 -0
- package/lib/mjs/make-bindable-component/types/upgrade-to-binding-props.js.map +1 -0
- package/lib/mjs/resolveable/exports.js +3 -0
- package/lib/mjs/resolveable/exports.js.map +1 -0
- package/lib/mjs/resolveable/types.js +2 -0
- package/lib/mjs/resolveable/types.js.map +1 -0
- package/lib/mjs/resolveable/utils.js +10 -0
- package/lib/mjs/resolveable/utils.js.map +1 -0
- package/lib/mjs/specialized-bindings/const-binding.js +11 -0
- package/lib/mjs/specialized-bindings/const-binding.js.map +1 -0
- package/lib/mjs/specialized-bindings/derived-binding/exports.js +3 -0
- package/lib/mjs/specialized-bindings/derived-binding/exports.js.map +1 -0
- package/lib/mjs/specialized-bindings/derived-binding/options.js +2 -0
- package/lib/mjs/specialized-bindings/derived-binding/options.js.map +1 -0
- package/lib/mjs/specialized-bindings/derived-binding/use-derived-binding.js +40 -0
- package/lib/mjs/specialized-bindings/derived-binding/use-derived-binding.js.map +1 -0
- package/lib/mjs/specialized-bindings/exports.js +5 -0
- package/lib/mjs/specialized-bindings/exports.js.map +1 -0
- package/lib/mjs/specialized-bindings/flattened-binding.js +55 -0
- package/lib/mjs/specialized-bindings/flattened-binding.js.map +1 -0
- package/lib/mjs/specialized-bindings/transient-derived-binding/exports.js +4 -0
- package/lib/mjs/specialized-bindings/transient-derived-binding/exports.js.map +1 -0
- package/lib/mjs/specialized-bindings/transient-derived-binding/make-transient-derived-binding.js +49 -0
- package/lib/mjs/specialized-bindings/transient-derived-binding/make-transient-derived-binding.js.map +1 -0
- package/lib/mjs/specialized-bindings/transient-derived-binding/types/exports.js +2 -0
- package/lib/mjs/specialized-bindings/transient-derived-binding/types/exports.js.map +1 -0
- package/lib/mjs/specialized-bindings/transient-derived-binding/types/transient-derived-binding-args.js +2 -0
- package/lib/mjs/specialized-bindings/transient-derived-binding/types/transient-derived-binding-args.js.map +1 -0
- package/lib/mjs/specialized-bindings/transient-derived-binding/use-transient-derived-binding.js +14 -0
- package/lib/mjs/specialized-bindings/transient-derived-binding/use-transient-derived-binding.js.map +1 -0
- package/lib/mjs/synchronization/exports.js +4 -0
- package/lib/mjs/synchronization/exports.js.map +1 -0
- package/lib/mjs/synchronization/types/exports.js +2 -0
- package/lib/mjs/synchronization/types/exports.js.map +1 -0
- package/lib/mjs/synchronization/types/options.js +2 -0
- package/lib/mjs/synchronization/types/options.js.map +1 -0
- package/lib/mjs/synchronization/use-bi-dir-binding-sync.js +12 -0
- package/lib/mjs/synchronization/use-bi-dir-binding-sync.js.map +1 -0
- package/lib/mjs/synchronization/use-uni-dir-binding-sync.js +6 -0
- package/lib/mjs/synchronization/use-uni-dir-binding-sync.js.map +1 -0
- package/lib/mjs/types/array-like.js +2 -0
- package/lib/mjs/types/array-like.js.map +1 -0
- package/lib/mjs/types/empty.js +2 -0
- package/lib/mjs/types/empty.js.map +1 -0
- package/lib/mjs/types/exports.js +3 -0
- package/lib/mjs/types/exports.js.map +1 -0
- package/lib/mjs/use-binding-effect/exports.js +3 -0
- package/lib/mjs/use-binding-effect/exports.js.map +1 -0
- package/lib/mjs/use-binding-effect/types/exports.js +2 -0
- package/lib/mjs/use-binding-effect/types/exports.js.map +1 -0
- package/lib/mjs/use-binding-effect/types/options.js +2 -0
- package/lib/mjs/use-binding-effect/types/options.js.map +1 -0
- package/lib/mjs/use-binding-effect/use-binding-effect.js +141 -0
- package/lib/mjs/use-binding-effect/use-binding-effect.js.map +1 -0
- package/lib/mjs/utility-hooks/exports.js +3 -0
- package/lib/mjs/utility-hooks/exports.js.map +1 -0
- package/lib/mjs/utility-hooks/use-callback-ref.js +11 -0
- package/lib/mjs/utility-hooks/use-callback-ref.js.map +1 -0
- package/lib/mjs/utility-hooks/use-stable-value.js +14 -0
- package/lib/mjs/utility-hooks/use-stable-value.js.map +1 -0
- package/lib/resolveable/exports.d.ts +3 -0
- package/lib/resolveable/exports.d.ts.map +1 -0
- package/lib/resolveable/types.d.ts +10 -0
- package/lib/resolveable/types.d.ts.map +1 -0
- package/lib/resolveable/utils.d.ts +10 -0
- package/lib/resolveable/utils.d.ts.map +1 -0
- package/lib/specialized-bindings/const-binding.d.ts +10 -0
- package/lib/specialized-bindings/const-binding.d.ts.map +1 -0
- package/lib/specialized-bindings/derived-binding/exports.d.ts +3 -0
- package/lib/specialized-bindings/derived-binding/exports.d.ts.map +1 -0
- package/lib/specialized-bindings/derived-binding/options.d.ts +52 -0
- package/lib/specialized-bindings/derived-binding/options.d.ts.map +1 -0
- package/lib/specialized-bindings/derived-binding/use-derived-binding.d.ts +16 -0
- package/lib/specialized-bindings/derived-binding/use-derived-binding.d.ts.map +1 -0
- package/lib/specialized-bindings/exports.d.ts +5 -0
- package/lib/specialized-bindings/exports.d.ts.map +1 -0
- package/lib/specialized-bindings/flattened-binding.d.ts +16 -0
- package/lib/specialized-bindings/flattened-binding.d.ts.map +1 -0
- package/lib/specialized-bindings/transient-derived-binding/exports.d.ts +4 -0
- package/lib/specialized-bindings/transient-derived-binding/exports.d.ts.map +1 -0
- package/lib/specialized-bindings/transient-derived-binding/make-transient-derived-binding.d.ts +12 -0
- package/lib/specialized-bindings/transient-derived-binding/make-transient-derived-binding.d.ts.map +1 -0
- package/lib/specialized-bindings/transient-derived-binding/types/exports.d.ts +2 -0
- package/lib/specialized-bindings/transient-derived-binding/types/exports.d.ts.map +1 -0
- package/lib/specialized-bindings/transient-derived-binding/types/transient-derived-binding-args.d.ts +10 -0
- package/lib/specialized-bindings/transient-derived-binding/types/transient-derived-binding-args.d.ts.map +1 -0
- package/lib/specialized-bindings/transient-derived-binding/use-transient-derived-binding.d.ts +13 -0
- package/lib/specialized-bindings/transient-derived-binding/use-transient-derived-binding.d.ts.map +1 -0
- package/lib/synchronization/exports.d.ts +4 -0
- package/lib/synchronization/exports.d.ts.map +1 -0
- package/lib/synchronization/types/exports.d.ts +2 -0
- package/lib/synchronization/types/exports.d.ts.map +1 -0
- package/lib/synchronization/types/options.d.ts +13 -0
- package/lib/synchronization/types/options.d.ts.map +1 -0
- package/lib/synchronization/use-bi-dir-binding-sync.d.ts +10 -0
- package/lib/synchronization/use-bi-dir-binding-sync.d.ts.map +1 -0
- package/lib/synchronization/use-uni-dir-binding-sync.d.ts +6 -0
- package/lib/synchronization/use-uni-dir-binding-sync.d.ts.map +1 -0
- package/lib/types/array-like.d.ts +3 -0
- package/lib/types/array-like.d.ts.map +1 -0
- package/lib/types/empty.d.ts +3 -0
- package/lib/types/empty.d.ts.map +1 -0
- package/lib/types/exports.d.ts +3 -0
- package/lib/types/exports.d.ts.map +1 -0
- package/lib/use-binding-effect/exports.d.ts +3 -0
- package/lib/use-binding-effect/exports.d.ts.map +1 -0
- package/lib/use-binding-effect/types/exports.d.ts +2 -0
- package/lib/use-binding-effect/types/exports.d.ts.map +1 -0
- package/lib/use-binding-effect/types/options.d.ts +46 -0
- package/lib/use-binding-effect/types/options.d.ts.map +1 -0
- package/lib/use-binding-effect/use-binding-effect.d.ts +21 -0
- package/lib/use-binding-effect/use-binding-effect.d.ts.map +1 -0
- package/lib/utility-hooks/exports.d.ts +3 -0
- package/lib/utility-hooks/exports.d.ts.map +1 -0
- package/lib/utility-hooks/use-callback-ref.d.ts +3 -0
- package/lib/utility-hooks/use-callback-ref.d.ts.map +1 -0
- package/lib/utility-hooks/use-stable-value.d.ts +6 -0
- package/lib/utility-hooks/use-stable-value.d.ts.map +1 -0
- package/package.json +70 -0
- package/src/__test_dependency__/index.ts +4 -0
- package/src/__test_dependency__/run-in-dom.tsx +46 -0
- package/src/__test_dependency__/sleep.ts +3 -0
- package/src/bc/bc.tsx +12 -0
- package/src/bc/exports.ts +1 -0
- package/src/binding/__tests__/make-binding.test.ts +25 -0
- package/src/binding/__tests__/use-binding.test.tsx +54 -0
- package/src/binding/exports.ts +3 -0
- package/src/binding/internal/DoubleLinkedList/__tests__/double-linked-list.test.ts +134 -0
- package/src/binding/internal/DoubleLinkedList/index.ts +128 -0
- package/src/binding/internal/__tests__/custom-value-comparison.test.ts +31 -0
- package/src/binding/internal/__tests__/default-settings.test.ts +92 -0
- package/src/binding/internal/__tests__/default-value-comparison.test.ts +55 -0
- package/src/binding/internal/__tests__/locking.test.ts +111 -0
- package/src/binding/internal/__tests__/transformed.test.ts +48 -0
- package/src/binding/internal/binding-impl.ts +253 -0
- package/src/binding/internal/consts.ts +2 -0
- package/src/binding/make-binding.ts +26 -0
- package/src/binding/types/binding-args.ts +49 -0
- package/src/binding/types/binding-dependencies.ts +7 -0
- package/src/binding/types/binding-initializer.ts +2 -0
- package/src/binding/types/binding.ts +25 -0
- package/src/binding/types/change-listener.ts +5 -0
- package/src/binding/types/exports.ts +11 -0
- package/src/binding/types/infer-binding-value-types.ts +14 -0
- package/src/binding/types/infer-bindings-array-value-types.ts +12 -0
- package/src/binding/types/infer-named-binding-value-types.ts +12 -0
- package/src/binding/types/inference.ts +4 -0
- package/src/binding/types/readonly-binding.ts +39 -0
- package/src/binding/types/set-value-transformer.ts +11 -0
- package/src/binding/use-binding.ts +17 -0
- package/src/binding-utils/__tests__/are-all-bindings-locked.test.ts +40 -0
- package/src/binding-utils/__tests__/are-any-bindings-modified.test.ts +35 -0
- package/src/binding-utils/__tests__/lock-all-bindings.test.ts +36 -0
- package/src/binding-utils/__tests__/lock-bindings-and-do.test.ts +52 -0
- package/src/binding-utils/__tests__/set-all-bindings-modified.test.ts +22 -0
- package/src/binding-utils/exports.ts +3 -0
- package/src/binding-utils/internal/__tests__/make-value-then-do.test.ts +52 -0
- package/src/binding-utils/internal/make-value-then-do.ts +37 -0
- package/src/binding-utils/lock-utils.ts +50 -0
- package/src/binding-utils/modified-utils.ts +31 -0
- package/src/binding-utils/type-utils.ts +9 -0
- package/src/components/BindingsConsumer/__tests__/basic-rendering.test.tsx +75 -0
- package/src/components/BindingsConsumer/__tests__/debounced-rendering.test.tsx +93 -0
- package/src/components/BindingsConsumer/__tests__/multiple-bindings.test.tsx +94 -0
- package/src/components/BindingsConsumer/__tests__/nested-rendering.test.tsx +144 -0
- package/src/components/BindingsConsumer/__tests__/value-comparison.test.tsx +97 -0
- package/src/components/BindingsConsumer/__tests__/value-extraction.test.tsx +56 -0
- package/src/components/BindingsConsumer/index.tsx +77 -0
- package/src/components/BindingsConsumer/internal/Refreshable.tsx +38 -0
- package/src/components/BindingsConsumer/types/exports.ts +2 -0
- package/src/components/BindingsConsumer/types/props.ts +30 -0
- package/src/components/BindingsConsumer/types/render-callback.ts +15 -0
- package/src/components/exports.ts +1 -0
- package/src/config/are-equal.ts +16 -0
- package/src/config/exports.ts +5 -0
- package/src/config/logging.ts +31 -0
- package/src/config/stats-handler.ts +21 -0
- package/src/default-queue/__tests__/default-queue.test.tsx +32 -0
- package/src/default-queue/default-queue-context.tsx +48 -0
- package/src/default-queue/exports.ts +1 -0
- package/src/index.ts +14 -0
- package/src/internal-hooks/__tests__/use-is-mounted.test.ts +18 -0
- package/src/internal-hooks/use-is-mounted-ref.ts +16 -0
- package/src/internal-utils/__tests__/concat-arrays.test.ts +25 -0
- package/src/internal-utils/__tests__/extract-binding-dependency-values.test.ts +73 -0
- package/src/internal-utils/__tests__/normalize-as-array.test.ts +17 -0
- package/src/internal-utils/__tests__/normalize-as-optonal-array.test.ts +17 -0
- package/src/internal-utils/array-like.ts +26 -0
- package/src/internal-utils/extract-binding-dependency-values.ts +36 -0
- package/src/internal-utils/get-typed-keys.ts +6 -0
- package/src/internal-utils/uid.ts +4 -0
- package/src/limiter/__tests__/use-limiter.test.ts +227 -0
- package/src/limiter/exports.ts +4 -0
- package/src/limiter/internal/LimiterImpl.ts +73 -0
- package/src/limiter/make-limiter.ts +20 -0
- package/src/limiter/pick-limiter-options.ts +9 -0
- package/src/limiter/types/LimitMode.ts +6 -0
- package/src/limiter/types/LimitType.ts +31 -0
- package/src/limiter/types/Limiter.ts +10 -0
- package/src/limiter/types/LimiterOptions.ts +38 -0
- package/src/limiter/types/exports.ts +4 -0
- package/src/limiter/use-limiter.ts +52 -0
- package/src/make-bindable-component/__tests__/make-bindable-component.test.tsx +30 -0
- package/src/make-bindable-component/exports.ts +2 -0
- package/src/make-bindable-component/make-bindable-component.tsx +78 -0
- package/src/make-bindable-component/types/exports.ts +2 -0
- package/src/make-bindable-component/types/make-bindable-component-options.ts +6 -0
- package/src/make-bindable-component/types/upgrade-to-binding-props.tsx +11 -0
- package/src/resolveable/__tests__/resolve-type-or-binding-type.test.ts +22 -0
- package/src/resolveable/__tests__/resolve-type-or-deferred-type-or-binding-type.test.ts +26 -0
- package/src/resolveable/__tests__/resolve-type-or-deferred-type-with-args.test.ts +19 -0
- package/src/resolveable/__tests__/resolve-type-or-deferred-type.test.ts +19 -0
- package/src/resolveable/exports.ts +2 -0
- package/src/resolveable/types.ts +13 -0
- package/src/resolveable/utils.ts +17 -0
- package/src/specialized-bindings/__tests__/const-binding.test.tsx +43 -0
- package/src/specialized-bindings/__tests__/flattened-binding.test.ts +45 -0
- package/src/specialized-bindings/const-binding.ts +19 -0
- package/src/specialized-bindings/derived-binding/__tests__/basic.test.ts +94 -0
- package/src/specialized-bindings/derived-binding/__tests__/derivations-of-derivations.test.ts +71 -0
- package/src/specialized-bindings/derived-binding/__tests__/multiple-dependencies.test.ts +60 -0
- package/src/specialized-bindings/derived-binding/exports.ts +2 -0
- package/src/specialized-bindings/derived-binding/options.ts +56 -0
- package/src/specialized-bindings/derived-binding/use-derived-binding.ts +77 -0
- package/src/specialized-bindings/exports.ts +4 -0
- package/src/specialized-bindings/flattened-binding.ts +104 -0
- package/src/specialized-bindings/transient-derived-binding/__tests__/basic.test.ts +75 -0
- package/src/specialized-bindings/transient-derived-binding/__tests__/derivations-of-derivations.test.ts +69 -0
- package/src/specialized-bindings/transient-derived-binding/__tests__/multiple-dependencies.test.ts +52 -0
- package/src/specialized-bindings/transient-derived-binding/exports.ts +3 -0
- package/src/specialized-bindings/transient-derived-binding/make-transient-derived-binding.ts +63 -0
- package/src/specialized-bindings/transient-derived-binding/types/exports.ts +1 -0
- package/src/specialized-bindings/transient-derived-binding/types/transient-derived-binding-args.ts +11 -0
- package/src/specialized-bindings/transient-derived-binding/use-transient-derived-binding.ts +25 -0
- package/src/synchronization/__tests__/use-bi-dir-binding-sync.test.ts +27 -0
- package/src/synchronization/__tests__/use-uni-dir-binding-sync.test.ts +23 -0
- package/src/synchronization/exports.ts +3 -0
- package/src/synchronization/types/exports.ts +1 -0
- package/src/synchronization/types/options.ts +15 -0
- package/src/synchronization/use-bi-dir-binding-sync.ts +14 -0
- package/src/synchronization/use-uni-dir-binding-sync.ts +9 -0
- package/src/types/array-like.ts +2 -0
- package/src/types/empty.ts +2 -0
- package/src/types/exports.ts +2 -0
- package/src/use-binding-effect/__tests__/basic.test.ts +70 -0
- package/src/use-binding-effect/__tests__/throttled.test.ts +106 -0
- package/src/use-binding-effect/__tests__/trigger-on-mount.test.tsx +125 -0
- package/src/use-binding-effect/__tests__/value-comparison.test.ts +71 -0
- package/src/use-binding-effect/exports.ts +2 -0
- package/src/use-binding-effect/types/exports.ts +1 -0
- package/src/use-binding-effect/types/options.ts +50 -0
- package/src/use-binding-effect/use-binding-effect.ts +204 -0
- package/src/utility-hooks/__tests__/use-callback-ref.test.tsx +59 -0
- package/src/utility-hooks/__tests__/use-stable-value.test.tsx +49 -0
- package/src/utility-hooks/exports.ts +2 -0
- package/src/utility-hooks/use-callback-ref.ts +15 -0
- package/src/utility-hooks/use-stable-value.ts +17 -0
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
import { DEFAULT_PRIORITY } from 'std-client-run-queue';
|
|
2
|
+
import { useEffect, useMemo, useRef } from 'react';
|
|
3
|
+
|
|
4
|
+
import { useDefaultQueue } from '../default-queue/default-queue-context';
|
|
5
|
+
import { LimiterImpl } from './internal/LimiterImpl';
|
|
6
|
+
import type { Limiter } from './types/Limiter';
|
|
7
|
+
import type { LimiterOptions } from './types/LimiterOptions';
|
|
8
|
+
|
|
9
|
+
const noOp = () => {};
|
|
10
|
+
|
|
11
|
+
/** Creates a limiter which can be used to debounce or throttle a function call. */
|
|
12
|
+
export const useLimiter = ({
|
|
13
|
+
id,
|
|
14
|
+
cancelOnUnmount = false,
|
|
15
|
+
limitType = 'debounce',
|
|
16
|
+
limitMode = 'trailing',
|
|
17
|
+
limitMSec = 0,
|
|
18
|
+
priority = DEFAULT_PRIORITY,
|
|
19
|
+
queue
|
|
20
|
+
}: LimiterOptions & {
|
|
21
|
+
/** A technical, but human-readable ID, which isn't guaranteed to be unique */
|
|
22
|
+
id: string;
|
|
23
|
+
/**
|
|
24
|
+
* If `true`, any previously scheduled functions are automatically canceled on unmount
|
|
25
|
+
*
|
|
26
|
+
* @defaultValue `false`
|
|
27
|
+
*/
|
|
28
|
+
cancelOnUnmount?: boolean;
|
|
29
|
+
}) => {
|
|
30
|
+
const defaultQueue = useDefaultQueue();
|
|
31
|
+
|
|
32
|
+
queue = queue ?? defaultQueue;
|
|
33
|
+
|
|
34
|
+
const previousLimiter = useRef<Limiter | undefined>();
|
|
35
|
+
const limiter = useMemo<Limiter>(
|
|
36
|
+
() => new LimiterImpl(id, { limitMSec, limitMode, limitType, priority, queue: queue! }),
|
|
37
|
+
[id, limitMSec, limitMode, limitType, priority, queue]
|
|
38
|
+
);
|
|
39
|
+
|
|
40
|
+
// If the limiter changed, cancel the previous one since it's no longer managed by this hook
|
|
41
|
+
if (previousLimiter.current !== undefined && previousLimiter.current !== limiter) {
|
|
42
|
+
previousLimiter.current.cancel();
|
|
43
|
+
}
|
|
44
|
+
previousLimiter.current = limiter;
|
|
45
|
+
|
|
46
|
+
const unmountCleanup = useRef(noOp);
|
|
47
|
+
unmountCleanup.current = cancelOnUnmount ? () => limiter.cancel() : noOp;
|
|
48
|
+
|
|
49
|
+
useEffect(() => (cancelOnUnmount ? () => unmountCleanup.current() : undefined));
|
|
50
|
+
|
|
51
|
+
return limiter;
|
|
52
|
+
};
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { waitFor } from '@testing-library/react';
|
|
2
|
+
import React from 'react';
|
|
3
|
+
|
|
4
|
+
import { runInDom } from '../../__test_dependency__';
|
|
5
|
+
import { useBinding } from '../../binding/use-binding';
|
|
6
|
+
import { makeBindableComponent } from '../make-bindable-component';
|
|
7
|
+
|
|
8
|
+
describe('makeBindableComponent', () => {
|
|
9
|
+
it('should work', () =>
|
|
10
|
+
runInDom(({ onMount }) => {
|
|
11
|
+
const MyComponent = makeBindableComponent(({ value }: { value: string }) => <span>{value}</span>);
|
|
12
|
+
|
|
13
|
+
const two = useBinding(() => 'two', { id: 'two', detectChanges: true });
|
|
14
|
+
|
|
15
|
+
onMount(async (rootElement) => {
|
|
16
|
+
expect(rootElement.innerHTML).toBe('<div><span>one</span><span>two</span></div>');
|
|
17
|
+
|
|
18
|
+
two.set('three');
|
|
19
|
+
|
|
20
|
+
await waitFor(() => expect(rootElement.innerHTML).toBe('<div><span>one</span><span>three</span></div>'));
|
|
21
|
+
});
|
|
22
|
+
|
|
23
|
+
return (
|
|
24
|
+
<>
|
|
25
|
+
<MyComponent value="one" />
|
|
26
|
+
<MyComponent value={two} />
|
|
27
|
+
</>
|
|
28
|
+
);
|
|
29
|
+
}));
|
|
30
|
+
});
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
|
|
3
|
+
import type { ReadonlyBinding } from '../binding/types/readonly-binding';
|
|
4
|
+
import { isBinding } from '../binding-utils/type-utils';
|
|
5
|
+
import { BindingsConsumer } from '../components/BindingsConsumer';
|
|
6
|
+
import { resolveTypeOrBindingType } from '../resolveable/utils';
|
|
7
|
+
import type { MakeBindableComponentOptions } from './types/make-bindable-component-options';
|
|
8
|
+
import type { UpgradeToBindingsProps } from './types/upgrade-to-binding-props';
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Take a functional component and creates a new functional component that takes binding props. The non-bound types are also still
|
|
12
|
+
* accepted.
|
|
13
|
+
*
|
|
14
|
+
* The component will be re-rendered any time binding props change.
|
|
15
|
+
*
|
|
16
|
+
* The bindings are resolved before calling the original component.
|
|
17
|
+
*
|
|
18
|
+
* Bindings can also be passed through by specifying key names in the `passThru` option.
|
|
19
|
+
*/
|
|
20
|
+
export function makeBindableComponent<PropsT extends Record<string, any>, PassThruKeyT extends keyof PropsT & string = never>(
|
|
21
|
+
functionalComponent: (props: PropsT) => JSX.Element
|
|
22
|
+
): (props: UpgradeToBindingsProps<PropsT, PassThruKeyT>) => JSX.Element;
|
|
23
|
+
export function makeBindableComponent<PropsT extends Record<string, any>, PassThruKeyT extends keyof PropsT & string = never>(
|
|
24
|
+
options: MakeBindableComponentOptions<PropsT, PassThruKeyT>,
|
|
25
|
+
functionalComponent: (props: PropsT) => JSX.Element
|
|
26
|
+
): (props: UpgradeToBindingsProps<PropsT, PassThruKeyT>) => JSX.Element;
|
|
27
|
+
export function makeBindableComponent<PropsT extends Record<string, any>, PassThruKeyT extends keyof PropsT & string = never>(
|
|
28
|
+
optionsOrFunctionalComponent: MakeBindableComponentOptions<PropsT, PassThruKeyT> | ((props: PropsT) => JSX.Element),
|
|
29
|
+
theFunctionalComponent?: (props: PropsT) => JSX.Element
|
|
30
|
+
): (props: UpgradeToBindingsProps<PropsT, PassThruKeyT>) => JSX.Element {
|
|
31
|
+
const { passThru, bindingsConsumerProps } =
|
|
32
|
+
typeof optionsOrFunctionalComponent === 'function'
|
|
33
|
+
? ({} satisfies MakeBindableComponentOptions<PropsT, PassThruKeyT>)
|
|
34
|
+
: optionsOrFunctionalComponent;
|
|
35
|
+
const functionalComponent = (typeof optionsOrFunctionalComponent === 'function' ? optionsOrFunctionalComponent : theFunctionalComponent)!;
|
|
36
|
+
|
|
37
|
+
const passThruSet = new Set(passThru ?? []);
|
|
38
|
+
|
|
39
|
+
return (props: UpgradeToBindingsProps<PropsT, PassThruKeyT>) => {
|
|
40
|
+
const bindings = getAllBindings(props, passThruSet);
|
|
41
|
+
return bindings.length > 0 ? (
|
|
42
|
+
<BindingsConsumer {...bindingsConsumerProps} bindings={bindings}>
|
|
43
|
+
{() => functionalComponent(resolveBindings(props, passThruSet) as PropsT)}
|
|
44
|
+
</BindingsConsumer>
|
|
45
|
+
) : (
|
|
46
|
+
functionalComponent(props as PropsT)
|
|
47
|
+
);
|
|
48
|
+
};
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
// Helpers
|
|
52
|
+
|
|
53
|
+
const getAllBindings = (obj: Record<string, any>, passThru: Set<string>) => {
|
|
54
|
+
const output: ReadonlyBinding[] = [];
|
|
55
|
+
|
|
56
|
+
for (const [key, value] of Object.entries(obj)) {
|
|
57
|
+
if (!passThru.has(key) && isBinding(value)) {
|
|
58
|
+
output.push(value);
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
return output;
|
|
63
|
+
};
|
|
64
|
+
|
|
65
|
+
const resolveBindings = <PropsT extends Record<string, any>>(props: PropsT, passThru: Set<string>): PropsT =>
|
|
66
|
+
Object.entries(props).reduce((out, [key, value]) => {
|
|
67
|
+
if (passThru.has(key)) {
|
|
68
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
|
|
69
|
+
out[key as keyof PropsT] = value;
|
|
70
|
+
|
|
71
|
+
return out;
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
|
|
75
|
+
out[key as keyof PropsT] = resolveTypeOrBindingType(value);
|
|
76
|
+
|
|
77
|
+
return out;
|
|
78
|
+
}, {} as Partial<PropsT>) as PropsT;
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import type { BindingsConsumerProps } from '../../components/BindingsConsumer';
|
|
2
|
+
|
|
3
|
+
export interface MakeBindableComponentOptions<PropsT extends Record<string, any>, PassThruKeyT extends keyof PropsT & string = never> {
|
|
4
|
+
passThru?: PassThruKeyT[];
|
|
5
|
+
bindingsConsumerProps?: Omit<BindingsConsumerProps<any>, 'bindings'>;
|
|
6
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { ReadonlyBinding } from '../../binding/types/readonly-binding';
|
|
2
|
+
|
|
3
|
+
export type UpgradeToBindingsProps<PropsT extends Record<string, any>, PassThruKeyT extends keyof PropsT & string = never> = {
|
|
4
|
+
[KeyT in keyof PropsT]: KeyT extends PassThruKeyT
|
|
5
|
+
? PropsT[KeyT]
|
|
6
|
+
: ReadonlyBinding extends PropsT[KeyT]
|
|
7
|
+
? never
|
|
8
|
+
: undefined extends PropsT[KeyT]
|
|
9
|
+
? PropsT[KeyT] | ReadonlyBinding<PropsT[KeyT] | undefined>
|
|
10
|
+
: PropsT[KeyT] | ReadonlyBinding<PropsT[KeyT]>;
|
|
11
|
+
};
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { makeBinding } from '../../binding/make-binding';
|
|
2
|
+
import { resolveTypeOrBindingType } from '../utils';
|
|
3
|
+
|
|
4
|
+
describe('resolveTypeOrBindingType', () => {
|
|
5
|
+
it('number should return number', () => {
|
|
6
|
+
expect(resolveTypeOrBindingType(5)).toBe(5);
|
|
7
|
+
});
|
|
8
|
+
|
|
9
|
+
it('string should return string', () => {
|
|
10
|
+
expect(resolveTypeOrBindingType('hello')).toBe('hello');
|
|
11
|
+
});
|
|
12
|
+
|
|
13
|
+
it('array should return array', () => {
|
|
14
|
+
expect(resolveTypeOrBindingType(['hello', 'world'])).toMatchObject(['hello', 'world']);
|
|
15
|
+
});
|
|
16
|
+
|
|
17
|
+
it('binding should return binding value', () => {
|
|
18
|
+
const b = makeBinding(() => 10, { id: 'b' });
|
|
19
|
+
|
|
20
|
+
expect(resolveTypeOrBindingType(b)).toBe(10);
|
|
21
|
+
});
|
|
22
|
+
});
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { makeBinding } from '../../binding/make-binding';
|
|
2
|
+
import { resolveTypeOrDeferredTypeOrBindingType } from '../utils';
|
|
3
|
+
|
|
4
|
+
describe('resolveTypeOrDeferredTypeOrBindingType', () => {
|
|
5
|
+
it('number should return number', () => {
|
|
6
|
+
expect(resolveTypeOrDeferredTypeOrBindingType(5)).toBe(5);
|
|
7
|
+
});
|
|
8
|
+
|
|
9
|
+
it('string should return string', () => {
|
|
10
|
+
expect(resolveTypeOrDeferredTypeOrBindingType('hello')).toBe('hello');
|
|
11
|
+
});
|
|
12
|
+
|
|
13
|
+
it('array should return array', () => {
|
|
14
|
+
expect(resolveTypeOrDeferredTypeOrBindingType(['hello', 'world'])).toMatchObject(['hello', 'world']);
|
|
15
|
+
});
|
|
16
|
+
|
|
17
|
+
it('binding should return binding value', () => {
|
|
18
|
+
const b = makeBinding(() => 10, { id: 'b' });
|
|
19
|
+
|
|
20
|
+
expect(resolveTypeOrDeferredTypeOrBindingType(b)).toBe(10);
|
|
21
|
+
});
|
|
22
|
+
|
|
23
|
+
it('function should function result', () => {
|
|
24
|
+
expect(resolveTypeOrDeferredTypeOrBindingType(() => 20)).toBe(20);
|
|
25
|
+
});
|
|
26
|
+
});
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { resolveTypeOrDeferredTypeWithArgs } from '../utils';
|
|
2
|
+
|
|
3
|
+
describe('resolveTypeOrDeferredTypeWithArgs', () => {
|
|
4
|
+
it('number should return number', () => {
|
|
5
|
+
expect(resolveTypeOrDeferredTypeWithArgs(5, [3, 11])).toBe(5);
|
|
6
|
+
});
|
|
7
|
+
|
|
8
|
+
it('string should return string', () => {
|
|
9
|
+
expect(resolveTypeOrDeferredTypeWithArgs('hello', [3, 11])).toBe('hello');
|
|
10
|
+
});
|
|
11
|
+
|
|
12
|
+
it('array should return array', () => {
|
|
13
|
+
expect(resolveTypeOrDeferredTypeWithArgs(['hello', 'world'], [3, 11])).toMatchObject(['hello', 'world']);
|
|
14
|
+
});
|
|
15
|
+
|
|
16
|
+
it('function should function result', () => {
|
|
17
|
+
expect(resolveTypeOrDeferredTypeWithArgs((a: number, b: number) => a + b, [3, 11])).toBe(14);
|
|
18
|
+
});
|
|
19
|
+
});
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { resolveTypeOrDeferredType } from '../utils';
|
|
2
|
+
|
|
3
|
+
describe('resolveTypeOrDeferredType', () => {
|
|
4
|
+
it('number should return number', () => {
|
|
5
|
+
expect(resolveTypeOrDeferredType(5)).toBe(5);
|
|
6
|
+
});
|
|
7
|
+
|
|
8
|
+
it('string should return string', () => {
|
|
9
|
+
expect(resolveTypeOrDeferredType('hello')).toBe('hello');
|
|
10
|
+
});
|
|
11
|
+
|
|
12
|
+
it('array should return array', () => {
|
|
13
|
+
expect(resolveTypeOrDeferredType(['hello', 'world'])).toMatchObject(['hello', 'world']);
|
|
14
|
+
});
|
|
15
|
+
|
|
16
|
+
it('function should function result', () => {
|
|
17
|
+
expect(resolveTypeOrDeferredType(() => 10)).toBe(10);
|
|
18
|
+
});
|
|
19
|
+
});
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { ReadonlyBinding } from '../binding/types/readonly-binding';
|
|
2
|
+
|
|
3
|
+
/** Either an immediate value or a value that can be retrieved by calling a function */
|
|
4
|
+
export type TypeOrDeferredType<T> = T | (() => T);
|
|
5
|
+
|
|
6
|
+
/** Either an immediate value or a value that can be retrieved by calling a function with args */
|
|
7
|
+
export type TypeOrDeferredTypeWithArgs<T, ArgsT extends any[]> = T | ((...args: ArgsT) => T);
|
|
8
|
+
|
|
9
|
+
/** Either an immediate value or a binding that stores a value */
|
|
10
|
+
export type TypeOrBindingType<T> = T | ReadonlyBinding<T>;
|
|
11
|
+
|
|
12
|
+
/** Either an immediate value or a value that can be retrieved by calling a function or a binding that stores a value */
|
|
13
|
+
export type TypeOrDeferredTypeOrBindingType<T> = T | (() => T) | ReadonlyBinding<T>;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { isBinding } from '../binding-utils/type-utils';
|
|
2
|
+
import type { TypeOrBindingType, TypeOrDeferredType, TypeOrDeferredTypeOrBindingType, TypeOrDeferredTypeWithArgs } from './types';
|
|
3
|
+
|
|
4
|
+
/** Resolves the value out of a TypeOrBindingType */
|
|
5
|
+
export const resolveTypeOrBindingType = <T>(value: TypeOrBindingType<T>) => (isBinding(value) ? value.get() : value);
|
|
6
|
+
|
|
7
|
+
/** Resolves the value out of a TypeOrDeferredType */
|
|
8
|
+
export const resolveTypeOrDeferredType = <T>(value: TypeOrDeferredType<T>): T =>
|
|
9
|
+
typeof value === 'function' ? (value as () => T)() : (value as T);
|
|
10
|
+
|
|
11
|
+
/** Resolves the value out of a TypeOrDeferredTypeOrBindingType */
|
|
12
|
+
export const resolveTypeOrDeferredTypeOrBindingType = <T>(value: TypeOrDeferredTypeOrBindingType<T>) =>
|
|
13
|
+
isBinding(value) ? value.get() : typeof value === 'function' ? (value as () => T)() : (value as T);
|
|
14
|
+
|
|
15
|
+
/** Resolves the value out of a TypeOrDeferredType */
|
|
16
|
+
export const resolveTypeOrDeferredTypeWithArgs = <T, ArgsT extends any[]>(value: TypeOrDeferredTypeWithArgs<T, ArgsT>, args: ArgsT): T =>
|
|
17
|
+
typeof value === 'function' ? (value as (...args: ArgsT) => T)(...args) : (value as T);
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import { waitFor } from '@testing-library/react';
|
|
2
|
+
import React from 'react';
|
|
3
|
+
|
|
4
|
+
import { runInDom } from '../../__test_dependency__';
|
|
5
|
+
import type { ReadonlyBinding } from '../../binding/types/readonly-binding';
|
|
6
|
+
import { useBinding } from '../../binding/use-binding';
|
|
7
|
+
import { BindingsConsumer } from '../../components/BindingsConsumer';
|
|
8
|
+
import { useConstBinding } from '../const-binding';
|
|
9
|
+
|
|
10
|
+
describe('useConstBinding', () => {
|
|
11
|
+
it('initial value should work', () =>
|
|
12
|
+
runInDom(({ onMount }) => {
|
|
13
|
+
const a = useConstBinding(3, { id: 'a' });
|
|
14
|
+
|
|
15
|
+
onMount(() => {
|
|
16
|
+
expect(a.get()).toBe(3);
|
|
17
|
+
});
|
|
18
|
+
}));
|
|
19
|
+
|
|
20
|
+
it("if rerendered with a new value, the binding's value should change", () =>
|
|
21
|
+
runInDom(({ onMount }) => {
|
|
22
|
+
const value = useBinding(() => 0, { id: 'value' });
|
|
23
|
+
let constBinding: ReadonlyBinding<number> | undefined;
|
|
24
|
+
|
|
25
|
+
const MyComponent = ({ value }: { value: number }) => {
|
|
26
|
+
constBinding = useConstBinding(value, { id: 'a' });
|
|
27
|
+
|
|
28
|
+
return <span>{constBinding.get()}</span>;
|
|
29
|
+
};
|
|
30
|
+
|
|
31
|
+
onMount(async () => {
|
|
32
|
+
const constBindingUid = constBinding?.uid;
|
|
33
|
+
expect(constBinding?.get()).toBe(0);
|
|
34
|
+
|
|
35
|
+
value.set(1);
|
|
36
|
+
await waitFor(() => expect(constBinding?.get()).toBe(1));
|
|
37
|
+
|
|
38
|
+
expect(constBinding?.uid).toBe(constBindingUid);
|
|
39
|
+
});
|
|
40
|
+
|
|
41
|
+
return <BindingsConsumer bindings={{ value }}>{({ value }) => <MyComponent value={value} />}</BindingsConsumer>;
|
|
42
|
+
}));
|
|
43
|
+
});
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import { runInDom, sleep } from '../../__test_dependency__';
|
|
2
|
+
import { useBinding } from '../../binding/use-binding';
|
|
3
|
+
import { useFlattenedBinding } from '../flattened-binding';
|
|
4
|
+
|
|
5
|
+
describe('useFlattenedBinding', () => {
|
|
6
|
+
it('initial value should work', () =>
|
|
7
|
+
runInDom(() => {
|
|
8
|
+
const a = useBinding(() => 0, { id: 'test1' });
|
|
9
|
+
const b = useBinding(() => ({ myBinding: a, somethingElse: 3 }), { id: 'test2' });
|
|
10
|
+
const c = useFlattenedBinding({ b }, ({ b }) => b.myBinding, { id: 'test3' });
|
|
11
|
+
|
|
12
|
+
expect(c.get()).toBe(0);
|
|
13
|
+
}));
|
|
14
|
+
|
|
15
|
+
it('updating root binding should propagate synchronously', () =>
|
|
16
|
+
runInDom(({ onMount }) => {
|
|
17
|
+
const a = useBinding(() => 0, { id: 'test1' });
|
|
18
|
+
const b = useBinding(() => ({ myBinding: a, somethingElse: 3 }), { id: 'test2' });
|
|
19
|
+
const c = useFlattenedBinding({ b }, ({ b }) => b.myBinding, { id: 'test3' });
|
|
20
|
+
|
|
21
|
+
onMount(() => {
|
|
22
|
+
a.set(1);
|
|
23
|
+
expect(b.get()).toMatchObject({ myBinding: a, somethingElse: 3 });
|
|
24
|
+
expect(c.get()).toBe(1);
|
|
25
|
+
});
|
|
26
|
+
}));
|
|
27
|
+
|
|
28
|
+
it('switching root bindings should propagate asynchronously', () =>
|
|
29
|
+
runInDom(({ onMount }) => {
|
|
30
|
+
const a1 = useBinding(() => 0, { id: 'test1' });
|
|
31
|
+
const a2 = useBinding(() => 10, { id: 'test2' });
|
|
32
|
+
const b = useBinding(() => ({ myBinding: a1, somethingElse: 3 }), { id: 'test3' });
|
|
33
|
+
const c = useFlattenedBinding({ b }, ({ b }) => b.myBinding, { id: 'test4' });
|
|
34
|
+
|
|
35
|
+
onMount(async () => {
|
|
36
|
+
b.set({ myBinding: a2, somethingElse: 6 });
|
|
37
|
+
expect(b.get()).toMatchObject({ myBinding: a2, somethingElse: 6 });
|
|
38
|
+
expect(c.get()).toBe(0);
|
|
39
|
+
|
|
40
|
+
await sleep(50); // giving time to propagate
|
|
41
|
+
|
|
42
|
+
expect(c.get()).toBe(10);
|
|
43
|
+
});
|
|
44
|
+
}));
|
|
45
|
+
});
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { makeBinding } from '../binding/make-binding';
|
|
2
|
+
import type { ReadonlyBinding } from '../binding/types/readonly-binding';
|
|
3
|
+
import { useBinding } from '../binding/use-binding';
|
|
4
|
+
|
|
5
|
+
export interface ConstBindingArgs {
|
|
6
|
+
/** A technical, but human-readable ID, which isn't guaranteed to be unique */
|
|
7
|
+
id: string;
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
/** Makes a const binding without using any React contexts. */
|
|
11
|
+
export const makeConstBinding = <GetT>(value: GetT, { id }: ConstBindingArgs): ReadonlyBinding<GetT> => makeBinding(() => value, { id });
|
|
12
|
+
|
|
13
|
+
/** Use for cases where a binding is required in an interface but the underlying value is constant with respect to a single render */
|
|
14
|
+
export const useConstBinding = <GetT>(value: GetT, { id }: ConstBindingArgs): ReadonlyBinding<GetT> => {
|
|
15
|
+
const internalBinding = useBinding(() => value, { id, detectChanges: true });
|
|
16
|
+
internalBinding.setRaw(value);
|
|
17
|
+
|
|
18
|
+
return internalBinding;
|
|
19
|
+
};
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
import { jest } from '@jest/globals';
|
|
2
|
+
|
|
3
|
+
import { runInDom, sleep } from '../../../__test_dependency__';
|
|
4
|
+
import { useBinding } from '../../../binding/use-binding';
|
|
5
|
+
import { useDerivedBinding } from '../use-derived-binding';
|
|
6
|
+
|
|
7
|
+
describe('useDerivedBinding', () => {
|
|
8
|
+
it('should work with undefined bindings', () =>
|
|
9
|
+
runInDom(({ onMount }) => {
|
|
10
|
+
const derived = useDerivedBinding(
|
|
11
|
+
undefined,
|
|
12
|
+
(values) => {
|
|
13
|
+
expect(values).toBeUndefined();
|
|
14
|
+
return 1;
|
|
15
|
+
},
|
|
16
|
+
{ id: 'a' }
|
|
17
|
+
);
|
|
18
|
+
|
|
19
|
+
onMount(() => {
|
|
20
|
+
expect(derived.get()).toBe(1);
|
|
21
|
+
});
|
|
22
|
+
}));
|
|
23
|
+
|
|
24
|
+
it('initial value should work with named bindings', () =>
|
|
25
|
+
runInDom(({ onMount }) => {
|
|
26
|
+
const a = useBinding(() => 0, { id: 'a' });
|
|
27
|
+
|
|
28
|
+
const bTransformer = jest.fn(({ a }: { a: number }) => a + 1);
|
|
29
|
+
const b = useDerivedBinding({ a }, bTransformer, { id: 'a' });
|
|
30
|
+
|
|
31
|
+
onMount(() => {
|
|
32
|
+
expect(b.get()).toBe(1);
|
|
33
|
+
expect(bTransformer).toHaveBeenCalledTimes(1);
|
|
34
|
+
});
|
|
35
|
+
}));
|
|
36
|
+
|
|
37
|
+
it('initial value should work with single unnamed bindings', () =>
|
|
38
|
+
runInDom(({ onMount }) => {
|
|
39
|
+
const a = useBinding(() => 0, { id: 'a' });
|
|
40
|
+
|
|
41
|
+
const bTransformer = jest.fn(() => a.get() + 1);
|
|
42
|
+
const b = useDerivedBinding(a, bTransformer, { id: 'a' });
|
|
43
|
+
|
|
44
|
+
onMount(() => {
|
|
45
|
+
expect(b.get()).toBe(1);
|
|
46
|
+
expect(bTransformer).toHaveBeenCalledTimes(1);
|
|
47
|
+
});
|
|
48
|
+
}));
|
|
49
|
+
|
|
50
|
+
it('initial value should work with array of unnamed bindings', () =>
|
|
51
|
+
runInDom(({ onMount }) => {
|
|
52
|
+
const a = useBinding(() => 0, { id: 'a' });
|
|
53
|
+
|
|
54
|
+
const bTransformer = jest.fn(() => a.get() + 1);
|
|
55
|
+
const b = useDerivedBinding([a], bTransformer, { id: 'a' });
|
|
56
|
+
|
|
57
|
+
onMount(() => {
|
|
58
|
+
expect(b.get()).toBe(1);
|
|
59
|
+
expect(bTransformer).toHaveBeenCalledTimes(1);
|
|
60
|
+
});
|
|
61
|
+
}));
|
|
62
|
+
|
|
63
|
+
it('updates to dependencies should be propagated asynchronously', () =>
|
|
64
|
+
runInDom(({ onMount }) => {
|
|
65
|
+
const a = useBinding(() => 0, { id: 'a' });
|
|
66
|
+
|
|
67
|
+
const bTransformer = jest.fn(({ a }: { a: number }) => a + 1);
|
|
68
|
+
const b = useDerivedBinding({ a }, bTransformer, { id: 'b' });
|
|
69
|
+
|
|
70
|
+
onMount(async () => {
|
|
71
|
+
a.set(1);
|
|
72
|
+
expect(b.get()).toBe(1);
|
|
73
|
+
|
|
74
|
+
await sleep(50); // giving time to propagate
|
|
75
|
+
|
|
76
|
+
expect(b.get()).toBe(2);
|
|
77
|
+
expect(bTransformer).toHaveBeenCalledTimes(2);
|
|
78
|
+
});
|
|
79
|
+
}));
|
|
80
|
+
|
|
81
|
+
it('updates to dependencies should be propagated immediately when limitType=none', () =>
|
|
82
|
+
runInDom(({ onMount }) => {
|
|
83
|
+
const a = useBinding(() => 0, { id: 'a' });
|
|
84
|
+
|
|
85
|
+
const bTransformer = jest.fn(({ a }: { a: number }) => a + 1);
|
|
86
|
+
const b = useDerivedBinding({ a }, bTransformer, { id: 'a', limitType: 'none' });
|
|
87
|
+
|
|
88
|
+
onMount(() => {
|
|
89
|
+
a.set(1);
|
|
90
|
+
expect(b.get()).toBe(2);
|
|
91
|
+
expect(bTransformer).toHaveBeenCalledTimes(2);
|
|
92
|
+
});
|
|
93
|
+
}));
|
|
94
|
+
});
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
import { jest } from '@jest/globals';
|
|
2
|
+
|
|
3
|
+
import { runInDom, sleep } from '../../../__test_dependency__';
|
|
4
|
+
import { useBinding } from '../../../binding/use-binding';
|
|
5
|
+
import { useDerivedBinding } from '../use-derived-binding';
|
|
6
|
+
|
|
7
|
+
describe('useDerivedBinding', () => {
|
|
8
|
+
it('initial value should work with derivations of derivations', () =>
|
|
9
|
+
runInDom(({ onMount }) => {
|
|
10
|
+
const a = useBinding(() => 0, { id: 'a' });
|
|
11
|
+
const b = useDerivedBinding({ a }, ({ a }) => a + 1, { id: 'b' });
|
|
12
|
+
const c = useDerivedBinding({ b }, ({ b }) => b + 1, { id: 'c' });
|
|
13
|
+
|
|
14
|
+
const dTransformer = jest.fn(({ c }: { c: number }) => c + 1);
|
|
15
|
+
const d = useDerivedBinding({ c }, dTransformer, { id: 'd' });
|
|
16
|
+
|
|
17
|
+
onMount(() => {
|
|
18
|
+
expect(d.get()).toBe(3);
|
|
19
|
+
expect(dTransformer).toHaveBeenCalledTimes(1);
|
|
20
|
+
});
|
|
21
|
+
}));
|
|
22
|
+
|
|
23
|
+
it('updates to deepest dependency should be propagated asynchronously', () =>
|
|
24
|
+
runInDom(({ onMount }) => {
|
|
25
|
+
const a = useBinding(() => 0, { id: 'a' });
|
|
26
|
+
const b = useDerivedBinding({ a }, ({ a }) => a + 1, { id: 'b' });
|
|
27
|
+
const c = useDerivedBinding({ b }, ({ b }) => b + 1, { id: 'c' });
|
|
28
|
+
|
|
29
|
+
const dTransformer = jest.fn(({ c }: { c: number }) => c + 1);
|
|
30
|
+
const d = useDerivedBinding({ c }, dTransformer, { id: 'd' });
|
|
31
|
+
|
|
32
|
+
onMount(async () => {
|
|
33
|
+
a.set(1);
|
|
34
|
+
expect(b.get()).toBe(1);
|
|
35
|
+
expect(c.get()).toBe(2);
|
|
36
|
+
expect(d.get()).toBe(3);
|
|
37
|
+
|
|
38
|
+
await sleep(50); // giving time to propagate
|
|
39
|
+
|
|
40
|
+
expect(b.get()).toBe(2);
|
|
41
|
+
expect(c.get()).toBe(3);
|
|
42
|
+
expect(d.get()).toBe(4);
|
|
43
|
+
expect(dTransformer).toHaveBeenCalledTimes(2);
|
|
44
|
+
});
|
|
45
|
+
}));
|
|
46
|
+
|
|
47
|
+
it('multiple quick updates to deepest dependency should be propagated asynchronously, but only running the transformer once', () =>
|
|
48
|
+
runInDom(({ onMount }) => {
|
|
49
|
+
const a = useBinding(() => 0, { id: 'a' });
|
|
50
|
+
const b = useDerivedBinding({ a }, ({ a }) => a + 1, { id: 'b' });
|
|
51
|
+
const c = useDerivedBinding({ b }, ({ b }) => b + 1, { id: 'c' });
|
|
52
|
+
|
|
53
|
+
const dTransformer = jest.fn(({ c }: { c: number }) => c + 1);
|
|
54
|
+
const d = useDerivedBinding({ c }, dTransformer, { id: 'd' });
|
|
55
|
+
|
|
56
|
+
onMount(async () => {
|
|
57
|
+
a.set(1);
|
|
58
|
+
a.set(2);
|
|
59
|
+
expect(b.get()).toBe(1);
|
|
60
|
+
expect(c.get()).toBe(2);
|
|
61
|
+
expect(d.get()).toBe(3);
|
|
62
|
+
|
|
63
|
+
await sleep(50); // giving time to propagate
|
|
64
|
+
|
|
65
|
+
expect(b.get()).toBe(3);
|
|
66
|
+
expect(c.get()).toBe(4);
|
|
67
|
+
expect(d.get()).toBe(5);
|
|
68
|
+
expect(dTransformer).toHaveBeenCalledTimes(2);
|
|
69
|
+
});
|
|
70
|
+
}));
|
|
71
|
+
});
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
import { jest } from '@jest/globals';
|
|
2
|
+
|
|
3
|
+
import { runInDom, sleep } from '../../../__test_dependency__';
|
|
4
|
+
import { useBinding } from '../../../binding/use-binding';
|
|
5
|
+
import { useDerivedBinding } from '../use-derived-binding';
|
|
6
|
+
|
|
7
|
+
describe('useDerivedBinding', () => {
|
|
8
|
+
it('initial value should work with multiple dependencies', () =>
|
|
9
|
+
runInDom(({ onMount }) => {
|
|
10
|
+
const a = useBinding(() => 0, { id: 'a' });
|
|
11
|
+
const b = useBinding(() => 1, { id: 'b' });
|
|
12
|
+
|
|
13
|
+
const cTransformer = jest.fn(({ a, b }: { a: number; b: number }) => a + b + 1);
|
|
14
|
+
const c = useDerivedBinding({ a, b }, cTransformer, { id: 'c' });
|
|
15
|
+
|
|
16
|
+
onMount(() => {
|
|
17
|
+
expect(c.get()).toBe(2);
|
|
18
|
+
expect(cTransformer).toHaveBeenCalledTimes(1);
|
|
19
|
+
});
|
|
20
|
+
}));
|
|
21
|
+
|
|
22
|
+
it('updates to one dependency should be propagated asynchronously', () =>
|
|
23
|
+
runInDom(({ onMount }) => {
|
|
24
|
+
const a = useBinding(() => 0, { id: 'a' });
|
|
25
|
+
const b = useBinding(() => 1, { id: 'b' });
|
|
26
|
+
|
|
27
|
+
const cTransformer = jest.fn(({ a, b }: { a: number; b: number }) => a + b + 1);
|
|
28
|
+
const c = useDerivedBinding({ a, b }, cTransformer, { id: 'c' });
|
|
29
|
+
|
|
30
|
+
onMount(async () => {
|
|
31
|
+
a.set(2);
|
|
32
|
+
expect(c.get()).toBe(2);
|
|
33
|
+
|
|
34
|
+
await sleep(50); // giving time to propagate
|
|
35
|
+
|
|
36
|
+
expect(c.get()).toBe(4);
|
|
37
|
+
expect(cTransformer).toHaveBeenCalledTimes(2);
|
|
38
|
+
});
|
|
39
|
+
}));
|
|
40
|
+
|
|
41
|
+
it('quick updates to multiple dependencies should be propagated asynchronously, but only running the transformer once', () =>
|
|
42
|
+
runInDom(({ onMount }) => {
|
|
43
|
+
const a = useBinding(() => 0, { id: 'a' });
|
|
44
|
+
const b = useBinding(() => 1, { id: 'b' });
|
|
45
|
+
|
|
46
|
+
const cTransformer = jest.fn(({ a, b }: { a: number; b: number }) => a + b + 1);
|
|
47
|
+
const c = useDerivedBinding({ a, b }, cTransformer, { id: 'c' });
|
|
48
|
+
|
|
49
|
+
onMount(async () => {
|
|
50
|
+
a.set(2);
|
|
51
|
+
b.set(3);
|
|
52
|
+
expect(c.get()).toBe(2);
|
|
53
|
+
|
|
54
|
+
await sleep(50); // giving time to propagate
|
|
55
|
+
|
|
56
|
+
expect(c.get()).toBe(6);
|
|
57
|
+
expect(cTransformer).toHaveBeenCalledTimes(2);
|
|
58
|
+
});
|
|
59
|
+
}));
|
|
60
|
+
});
|