@ray-js/api 1.7.79 → 1.7.80

package/lib/MapKit-3.4.13.js

@@ -6,6 +6,22 @@ const factory = createFactory('MapKit');
 /**
  * @public
  * @since @ray-js/ray 1.2.10
+ *
+ * @example 基础调用
+ * ```tsx
+ * import { map } from '@ray-js/ray';
+ *
+ * const { chooseLocation } = map;
+ *
+ * chooseLocation({
+ *   success: (result) => {
+ *     console.log('chooseLocation success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('chooseLocation fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const chooseLocation = factory('chooseLocation', {
   namespace: 'map'
@@ -13,6 +29,26 @@ export const chooseLocation = factory('chooseLocation', {
 /**
  * @public
  * @since @ray-js/ray 1.2.10
+ *
+ * @example 基础调用
+ * ```tsx
+ * import { map } from '@ray-js/ray';
+ *
+ * const { getLocation } = map;
+ *
+ * getLocation({
+ *   type: 'gcj02',
+ *   altitude: false,
+ *   isHighAccuracy: false,
+ *   highAccuracyExpireTime: 3000,
+ *   success: (result) => {
+ *     console.log('getLocation success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('getLocation fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const getLocation = factory('getLocation', {
   namespace: 'map'
@@ -20,6 +56,22 @@ export const getLocation = factory('getLocation', {
 /**
  * @public
  * @since @ray-js/ray 1.2.10
+ *
+ * @example 基础调用
+ * ```tsx
+ * import { map } from '@ray-js/ray';
+ *
+ * const { getMapList } = map;
+ *
+ * getMapList({
+ *   success: (result) => {
+ *     console.log('getMapList success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('getMapList fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const getMapList = factory('getMapList', {
   namespace: 'map'
@@ -27,6 +79,22 @@ export const getMapList = factory('getMapList', {
 /**
  * @public
  * @since @ray-js/ray 1.2.10
+ *
+ * @example 基础调用
+ * ```tsx
+ * import { map } from '@ray-js/ray';
+ *
+ * const { isGeofenceReachLimit } = map;
+ *
+ * isGeofenceReachLimit({
+ *   success: (result) => {
+ *     console.log('isGeofenceReachLimit success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('isGeofenceReachLimit fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const isGeofenceReachLimit = factory('isGeofenceReachLimit', {
   namespace: 'map'
@@ -34,6 +102,22 @@ export const isGeofenceReachLimit = factory('isGeofenceReachLimit', {
 /**
  * @public
  * @since @ray-js/ray 1.2.10
+ *
+ * @example 基础调用
+ * ```tsx
+ * import { map } from '@ray-js/ray';
+ *
+ * const { openGeofenceMap } = map;
+ *
+ * openGeofenceMap({
+ *   success: () => {
+ *     console.log('openGeofenceMap success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('openGeofenceMap fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const openGeofenceMap = factory('openGeofenceMap', {
   namespace: 'map'
@@ -41,6 +125,27 @@ export const openGeofenceMap = factory('openGeofenceMap', {
 /**
  * @public
  * @since @ray-js/ray 1.2.10
+ *
+ * @example 基础调用
+ * ```tsx
+ * import { map } from '@ray-js/ray';
+ *
+ * const { openMapAppLocation } = map;
+ *
+ * openMapAppLocation({
+ *   latitude: 30.27,
+ *   longitude: 120.15,
+ *   name: 'example location',
+ *   address: 'example address',
+ *   mapType: 'MA',
+ *   success: () => {
+ *     console.log('openMapAppLocation success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('openMapAppLocation fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const openMapAppLocation = factory('openMapAppLocation', {
   namespace: 'map'
@@ -48,6 +153,28 @@ export const openMapAppLocation = factory('openMapAppLocation', {
 /**
  * @public
  * @since @ray-js/ray 1.2.10
+ *
+ * @example 基础调用
+ * ```tsx
+ * import { map } from '@ray-js/ray';
+ *
+ * const { registerGeofence } = map;
+ *
+ * registerGeofence({
+ *   geoTitle: 'home',
+ *   longitude: 120.15,
+ *   latitude: 30.27,
+ *   radius: 500,
+ *   geofenceId: 'fence_001',
+ *   type: 0,
+ *   success: () => {
+ *     console.log('registerGeofence success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('registerGeofence fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const registerGeofence = factory('registerGeofence', {
   namespace: 'map'
@@ -55,6 +182,23 @@ export const registerGeofence = factory('registerGeofence', {
 /**
  * @public
  * @since @ray-js/ray 1.2.10
+ *
+ * @example 基础调用
+ * ```tsx
+ * import { map } from '@ray-js/ray';
+ *
+ * const { unregisterGeofence } = map;
+ *
+ * unregisterGeofence({
+ *   geofenceId: 'fence_001',
+ *   success: () => {
+ *     console.log('unregisterGeofence success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('unregisterGeofence fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const unregisterGeofence = factory('unregisterGeofence', {
   namespace: 'map'
@@ -62,6 +206,24 @@ export const unregisterGeofence = factory('unregisterGeofence', {
 /**
  * @public
  * @since @ray-js/ray 1.2.10
+ *
+ * @example 基础调用
+ * ```tsx
+ * import { map } from '@ray-js/ray';
+ *
+ * const { updateGeofence } = map;
+ *
+ * updateGeofence({
+ *   registerGeoFence: [{ geofenceId: 'fence_001', longitude: 120.15, latitude: 30.27, radius: 500 }],
+ *   unregisterGeoFence: [],
+ *   success: (result) => {
+ *     console.log('updateGeofence success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('updateGeofence fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const updateGeofence = factory('updateGeofence', {
   namespace: 'map'
@@ -69,6 +231,25 @@ export const updateGeofence = factory('updateGeofence', {
 /**
  * @public
  * @since @ray-js/ray 1.4.38
+ *
+ * @example 基础调用
+ * ```tsx
+ * import { map } from '@ray-js/ray';
+ *
+ * const { transformLocation } = map;
+ *
+ * transformLocation({
+ *   type: 'gcj02',
+ *   latitude: 30.27,
+ *   longitude: 120.15,
+ *   success: (result) => {
+ *     console.log('transformLocation success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('transformLocation fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const transformLocation = factory('transformLocation', {
   namespace: 'map'
@@ -76,6 +257,24 @@ export const transformLocation = factory('transformLocation', {
 /**
  * @public
  * @since @ray-js/ray 1.4.41
+ *
+ * @example 基础调用
+ * ```tsx
+ * import { map } from '@ray-js/ray';
+ *
+ * const { reverseGeocodeLocation } = map;
+ *
+ * reverseGeocodeLocation({
+ *   longitude: 120.15,
+ *   latitude: 30.27,
+ *   success: (result) => {
+ *     console.log('reverseGeocodeLocation success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('reverseGeocodeLocation fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const reverseGeocodeLocation = factory('reverseGeocodeLocation', {
   namespace: 'map'
@@ -83,6 +282,24 @@ export const reverseGeocodeLocation = factory('reverseGeocodeLocation', {
 /**
  * @public
  * @since @ray-js/ray 1.4.41
+ *
+ * @example 基础调用
+ * ```tsx
+ * import { map } from '@ray-js/ray';
+ *
+ * const { coordinateWGS84ToGCJ02 } = map;
+ *
+ * coordinateWGS84ToGCJ02({
+ *   longitude: 120.15,
+ *   latitude: 30.27,
+ *   success: (result) => {
+ *     console.log('coordinateWGS84ToGCJ02 success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('coordinateWGS84ToGCJ02 fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const coordinateWGS84ToGCJ02 = factory('coordinateWGS84ToGCJ02', {
   namespace: 'map'
@@ -90,6 +307,24 @@ export const coordinateWGS84ToGCJ02 = factory('coordinateWGS84ToGCJ02', {
 /**
  * @public
  * @since @ray-js/ray 1.4.41
+ *
+ * @example 基础调用
+ * ```tsx
+ * import { map } from '@ray-js/ray';
+ *
+ * const { coordinateGCJ02ToWGS84 } = map;
+ *
+ * coordinateGCJ02ToWGS84({
+ *   longitude: 120.15,
+ *   latitude: 30.27,
+ *   success: (result) => {
+ *     console.log('coordinateGCJ02ToWGS84 success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('coordinateGCJ02ToWGS84 fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const coordinateGCJ02ToWGS84 = factory('coordinateGCJ02ToWGS84', {
   namespace: 'map'
@@ -97,6 +332,22 @@ export const coordinateGCJ02ToWGS84 = factory('coordinateGCJ02ToWGS84', {
 /**
  * @public
  * @since @ray-js/ray 1.4.41
+ *
+ * @example 基础调用
+ * ```tsx
+ * import { map } from '@ray-js/ray';
+ *
+ * const { getMapType } = map;
+ *
+ * getMapType({
+ *   success: (result) => {
+ *     console.log('getMapType success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('getMapType fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const getMapType = factory('getMapType', {
   namespace: 'map'

package/lib/MediaKit-3.4.1.d.ts

@@ -2,5 +2,21 @@
 /**
  * @public
  * @since @ray-js/ray 1.6.19
+ *
+ * @example 基础调用
+ * ```tsx
+ * import { media } from '@ray-js/ray';
+ *
+ * const { getRGBAudioManager } = media;
+ *
+ * getRGBAudioManager({
+ *   success: () => {
+ *     console.log('getRGBAudioManager success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('getRGBAudioManager fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export declare const getRGBAudioManager: typeof ty.media.getRGBAudioManager;

package/lib/MediaKit-3.4.1.js

@@ -6,6 +6,22 @@ const factory = createFactory('MediaKit');
 /**
  * @public
  * @since @ray-js/ray 1.6.19
+ *
+ * @example 基础调用
+ * ```tsx
+ * import { media } from '@ray-js/ray';
+ *
+ * const { getRGBAudioManager } = media;
+ *
+ * getRGBAudioManager({
+ *   success: () => {
+ *     console.log('getRGBAudioManager success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('getRGBAudioManager fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const getRGBAudioManager = factory('getRGBAudioManager', {
   namespace: 'media'