vesium 1.0.1-beta.51 → 1.0.1-beta.52

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/dist/index.mjs CHANGED
@@ -11,6 +11,8 @@ const CREATE_VIEWER_INJECTION_KEY = Symbol("CREATE_VIEWER_INJECTION_KEY");
11
11
  * @internal
12
12
  */
13
13
  const CREATE_VIEWER_COLLECTION = /* @__PURE__ */ new WeakMap();
14
+ /**
15
+ */
14
16
  function createViewer(...args) {
15
17
  const viewer = shallowRef();
16
18
  const readonlyViewer = shallowReadonly(viewer);
@@ -576,6 +578,7 @@ function tryRun(fn) {
576
578
  *
577
579
  * @param source The source value, which can be a reactive reference or an asynchronous getter.
578
580
  * @param options Conversion options
581
+ * @returns The converted value.
579
582
  *
580
583
  * @example
581
584
  * ```ts
@@ -608,6 +611,11 @@ async function toPromiseValue(source, options = {}) {
608
611
  * Easily use the `addEventListener` in `Cesium.Event` instances,
609
612
  * when the dependent data changes or the component is unmounted,
610
613
  * the listener function will automatically reload or destroy.
614
+ *
615
+ * @param event The Cesium.Event instance
616
+ * @param listener The listener function
617
+ * @param options additional options
618
+ * @returns A function that can be called to remove the event listener
611
619
  */
612
620
  function useCesiumEventListener(event, listener, options = {}) {
613
621
  const isActive = toRef(options.isActive ?? true);
@@ -652,6 +660,8 @@ function useViewer() {
652
660
  //#region useCameraState/index.ts
653
661
  /**
654
662
  * Reactive Cesium Camera state
663
+ * @param options options
664
+ * @returns Reactive camera states
655
665
  */
656
666
  function useCameraState(options = {}) {
657
667
  let getCamera = options.camera;
@@ -703,6 +713,8 @@ function computeLevel(height) {
703
713
  //#region useCesiumFps/index.ts
704
714
  /**
705
715
  * Reactive get the frame rate of Cesium
716
+ * @param options options
717
+ * @returns Reactive fps states
706
718
  */
707
719
  function useCesiumFps(options = {}) {
708
720
  const { delay = 100 } = options;
@@ -730,6 +742,8 @@ function useCesiumFps(options = {}) {
730
742
  * @param addFn - add SideEffect function. eg.`entites.add`
731
743
  * @param removeFn - Clean SideEffect function. eg.`entities.remove`
732
744
  * @param removeScopeArgs - The parameters to pass for `removeScope` triggered when the component is unmounted
745
+ *
746
+ * @returns Contains side effect addition and removal functions
733
747
  */
734
748
  function useCollectionScope(addFn, removeFn, removeScopeArgs) {
735
749
  const scope = shallowReactive(/* @__PURE__ */ new Set());