@apps-in-toss/web-framework 0.0.22 → 0.0.24

package/dist-web/startUpdateLocation.d.ts

@@ -1,183 +0,0 @@
-
-
-export interface EventEmitterSchema<K extends string, P extends unknown[]> {
-	name: K;
-	params: P;
-}
-declare enum Accuracy {
-	/**
-	 * 오차범위 3KM 이내
-	 */
-	Lowest = 1,
-	/**
-	 * 오차범위 1KM 이내
-	 */
-	Low,
-	/**
-	 * 오차범위 몇 백미터 이내
-	 */
-	Balanced,
-	/**
-	 * 오차범위 10M 이내
-	 */
-	High,
-	/**
-	 * 가장 높은 정확도
-	 */
-	Highest,
-	/**
-	 * 네비게이션을 위한 최고 정확도
-	 */
-	BestForNavigation
-}
-/**
- * @public
- * @category 위치 정보
- * @name Location
- * @description 위치 정보를 나타내는 객체예요.
- */
-export interface Location {
-	/**
-	 * Android에서만 지원하는 옵션이에요.
-	 *
-	 * - `FINE`: 정확한 위치
-	 * - `COARSE`: 대략적인 위치
-	 *
-	 * @see https://developer.android.com/codelabs/approximate-location
-	 */
-	accessLocation?: "FINE" | "COARSE";
-	/**
-	 * 위치가 업데이트된 시점의 유닉스 타임스탬프예요.
-	 */
-	timestamp: number;
-	/**
-	 * @description 위치 정보를 나타내는 객체예요. 자세한 내용은 [LocationCoords](/react-native/reference/framework/Types/LocationCoords.html)을 참고해주세요.
-	 */
-	coords: LocationCoords;
-}
-/**
- * @public
- * @category 위치 정보
- * @name LocationCoords
- * @description 세부 위치 정보를 나타내는 객체예요.
- */
-export interface LocationCoords {
-	/**
-	 * 위도
-	 */
-	latitude: number;
-	/**
-	 * 경도
-	 */
-	longitude: number;
-	/**
-	 * 높이
-	 */
-	altitude: number;
-	/**
-	 * 위치 정확도
-	 */
-	accuracy: number;
-	/**
-	 * 고도 정확도
-	 */
-	altitudeAccuracy: number;
-	/**
-	 * 방향
-	 */
-	heading: number;
-}
-export interface StartUpdateLocationOptions {
-	/**
-	 * 위치 정확도를 설정해요.
-	 */
-	accuracy: Accuracy;
-	/**
-	 * 위치 업데이트 주기를 밀리초(ms) 단위로 설정해요.
-	 */
-	timeInterval: number;
-	/**
-	 * 위치 변경 거리를 미터(m) 단위로 설정해요.
-	 */
-	distanceInterval: number;
-}
-export interface StartUpdateLocationSubscription extends EmitterSubscription {
-	remove: () => Promise<void>;
-}
-/**
- * @name UpdateLocationEventEmitter
- * @kind typedef
- * @description
- * 디바이스의 위치 정보 변경을 감지해요
- * @extends {EventEmitterSchema<'updateLocation', [Location]>}
- */
-export interface UpdateLocationEventEmitter extends EventEmitterSchema<"updateLocation", [
-	Location
-]> {
-}
-/**
- * @public
- * @category 위치 정보
- * @name startUpdateLocation
- * @description  디바이스의 위치 정보를 지속적으로 감지하고, 위치가 변경되면 콜백을 실행하는 함수예요. 콜백 함수를 등록하면 위치가 변경될 때마다 자동으로 호출돼요.
- * 실시간 위치 추적이 필요한 기능을 구현할 때 사용할 수 있어요. 예를 들어 지도 앱에서 사용자의 현재 위치를 실시간으로 업데이트할 때, 운동 앱에서 사용자의 이동 거리를 기록할 때 등이에요.
- * 위치 업데이트 주기와 정확도를 조정해 배터리 소모를 최소화하면서도 필요한 정보를 얻을 수 있어요.
- *
- * @param {StartUpdateLocationOptions} options - 위치 정보 감지에 필요한 설정 객체에요.
- * @param {number} [options.accuracy] 위치 정확도를 설정해요.
- * @param {number} [options.timeInterval] 위치 정보를 업데이트하는 최소 주기로, 단위는 밀리초(ms)예요. 이 값은 위치 업데이트가 발생하는 가장 짧은 간격을 설정하지만, 시스템이나 환경의 영향을 받아 지정한 주기보다 더 긴 간격으로 업데이트될 수 있어요.
- * @param {number} [options.distanceInterval] 위치 변경 거리를 미터(m) 단위로 설정해요.
- * @param {(location: Location) => void} [options.callback] 위치 정보가 변경될 때 호출되는 콜백 함수예요. 자세한 내용은 [Location](/react-native/reference/framework/Types/Location.html)을 참고해주세요.
- *
- * @example
- * ### 위치 정보 변경 감지하기
- *
- * ```tsx
- * import React, { useState, useEffect } from 'react';
- * 
- * import { startUpdateLocation } from '@apps-in-toss/web-framework';
- *
- * // 위치 정보 변경 감지하기
- * function LocationWatcher() {
- *   const [location, setLocation] = useState(null);
- *
- *   useEffect(() => {
- *     return startUpdateLocation({
- *       options: {
- *         accuracy: Accuracy.Balanced,
- *         timeInterval: 3000,
- *         distanceInterval: 10,
- *       },
- *       onEvent: (location) => {
- *         setLocation(location);
- *       },
- *       onError: (error) => {
- *         console.error('위치 정보를 가져오는데 실패했어요:', error);
- *       },
- *     });
- *   }, []);
- *
- *   if (location == null) {
- *     return <span>위치 정보를 가져오는 중이에요...</span>;
- *   }
- *
- *   return (
- *     <div>
- *       <span>위도: {location.coords.latitude}</span>
- *       <span>경도: {location.coords.longitude}</span>
- *       <span>위치 정확도: {location.coords.accuracy}m</span>
- *       <span>높이: {location.coords.altitude}m</span>
- *       <span>고도 정확도: {location.coords.altitudeAccuracy}m</span>
- *       <span>방향: {location.coords.heading}°</span>
- *     </div>
- *   );
- * }
- * ```
- */
-export declare function startUpdateLocation(eventParams: {
-	onEvent: (response: Location) => void;
-	onError: (error: unknown) => void;
-	options: StartUpdateLocationOptions;
-}): () => void;
-
-export {};