@ray-js/api 1.7.79 → 1.7.80

package/lib/HealthKit-6.5.0.d.ts

@@ -2,210 +2,813 @@
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { getHealthConnectStatus } = health;
+ *
+ * getHealthConnectStatus({
+ *   success: (status) => {
+ *     console.log('Health Connect status:', status);
+ *   },
+ *   fail: (error) => {
+ *     console.log('getHealthConnectStatus fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export declare const getHealthConnectStatus: typeof ty.health.getHealthConnectStatus;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { getHealthConnectStatusSync } = health;
+ *
+ * const result = getHealthConnectStatusSync();
+ * console.log('Health Connect status:', result);
+ * ```
  */
 export declare const getHealthConnectStatusSync: typeof ty.health.getHealthConnectStatusSync;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { insertRecords } = health;
+ *
+ * const records = JSON.stringify([{ type: 'steps', value: 1000 }]);
+ * insertRecords({
+ *   request: records,
+ *   success: (result) => {
+ *     console.log('insertRecords success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('insertRecords fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export declare const insertRecords: typeof ty.health.insertRecords;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { insertRecordsSync } = health;
+ *
+ * const records = JSON.stringify([{ type: 'steps', value: 1000 }]);
+ * const result = insertRecordsSync({ request: records });
+ * console.log('insertRecordsSync result', result);
+ * ```
  */
 export declare const insertRecordsSync: typeof ty.health.insertRecordsSync;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { authStatusPermissions } = health;
+ *
+ * authStatusPermissions({
+ *   readPermissions: ['1', '2'],
+ *   writePermissions: ['1', '2'],
+ *   success: (result) => {
+ *     console.log('authStatusPermissions value:', result.value);
+ *   },
+ *   fail: (error) => {
+ *     console.log('authStatusPermissions fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export declare const authStatusPermissions: typeof ty.health.authStatusPermissions;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { authStatusPermissionsSync } = health;
+ *
+ * const result = authStatusPermissionsSync({
+ *   readPermissions: ['1', '2'],
+ *   writePermissions: ['1', '2'],
+ * });
+ * console.log('authStatusPermissionsSync value:', result.value);
+ * ```
  */
 export declare const authStatusPermissionsSync: typeof ty.health.authStatusPermissionsSync;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { getSaveQuantityPermission } = health;
+ *
+ * getSaveQuantityPermission({
+ *   writePermission: 1,
+ *   success: (result) => {
+ *     console.log('getSaveQuantityPermission value:', result.value);
+ *   },
+ *   fail: (error) => {
+ *     console.log('getSaveQuantityPermission fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export declare const getSaveQuantityPermission: typeof ty.health.getSaveQuantityPermission;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { getSaveQuantityPermissionSync } = health;
+ *
+ * const result = getSaveQuantityPermissionSync({
+ *   writePermission: 1,
+ * });
+ * console.log('getSaveQuantityPermissionSync value:', result.value);
+ * ```
  */
 export declare const getSaveQuantityPermissionSync: typeof ty.health.getSaveQuantityPermissionSync;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { authQuantityWritePermissions } = health;
+ *
+ * authQuantityWritePermissions({
+ *   permissions: ['1', '2'],
+ *   success: () => {
+ *     console.log('authQuantityWritePermissions success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('authQuantityWritePermissions fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export declare const authQuantityWritePermissions: typeof ty.health.authQuantityWritePermissions;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { authQuantityWritePermissionsSync } = health;
+ *
+ * authQuantityWritePermissionsSync({
+ *   permissions: ['1', '2'],
+ * });
+ * ```
  */
 export declare const authQuantityWritePermissionsSync: typeof ty.health.authQuantityWritePermissionsSync;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { authCategoryWritePermissions } = health;
+ *
+ * authCategoryWritePermissions({
+ *   permissions: ['1', '2'],
+ *   success: () => {
+ *     console.log('authCategoryWritePermissions success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('authCategoryWritePermissions fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export declare const authCategoryWritePermissions: typeof ty.health.authCategoryWritePermissions;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { authCategoryWritePermissionsSync } = health;
+ *
+ * authCategoryWritePermissionsSync({
+ *   permissions: ['1', '2'],
+ * });
+ * ```
  */
 export declare const authCategoryWritePermissionsSync: typeof ty.health.authCategoryWritePermissionsSync;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { authQuantityReadPermissions } = health;
+ *
+ * authQuantityReadPermissions({
+ *   permissions: ['1', '2'],
+ *   success: () => {
+ *     console.log('authQuantityReadPermissions success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('authQuantityReadPermissions fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export declare const authQuantityReadPermissions: typeof ty.health.authQuantityReadPermissions;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { authQuantityReadPermissionsSync } = health;
+ *
+ * authQuantityReadPermissionsSync({
+ *   permissions: ['1', '2'],
+ * });
+ * ```
  */
 export declare const authQuantityReadPermissionsSync: typeof ty.health.authQuantityReadPermissionsSync;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { authCategoryReadPermissions } = health;
+ *
+ * authCategoryReadPermissions({
+ *   permissions: ['1', '2'],
+ *   success: () => {
+ *     console.log('authCategoryReadPermissions success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('authCategoryReadPermissions fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export declare const authCategoryReadPermissions: typeof ty.health.authCategoryReadPermissions;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { authCategoryReadPermissionsSync } = health;
+ *
+ * authCategoryReadPermissionsSync({
+ *   permissions: ['1', '2'],
+ * });
+ * ```
  */
 export declare const authCategoryReadPermissionsSync: typeof ty.health.authCategoryReadPermissionsSync;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { authCharacteristicReadPermissions } = health;
+ *
+ * authCharacteristicReadPermissions({
+ *   permissions: ['1', '2'],
+ *   success: () => {
+ *     console.log('authCharacteristicReadPermissions success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('authCharacteristicReadPermissions fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export declare const authCharacteristicReadPermissions: typeof ty.health.authCharacteristicReadPermissions;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { authCharacteristicReadPermissionsSync } = health;
+ *
+ * authCharacteristicReadPermissionsSync({
+ *   permissions: ['1', '2'],
+ * });
+ * ```
  */
 export declare const authCharacteristicReadPermissionsSync: typeof ty.health.authCharacteristicReadPermissionsSync;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { authQuantityRWPermissions } = health;
+ *
+ * authQuantityRWPermissions({
+ *   permissions: ['1', '2'],
+ *   success: () => {
+ *     console.log('authQuantityRWPermissions success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('authQuantityRWPermissions fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export declare const authQuantityRWPermissions: typeof ty.health.authQuantityRWPermissions;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { authQuantityRWPermissionsSync } = health;
+ *
+ * authQuantityRWPermissionsSync({
+ *   permissions: ['1', '2'],
+ * });
+ * ```
  */
 export declare const authQuantityRWPermissionsSync: typeof ty.health.authQuantityRWPermissionsSync;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { authCategoryRWPermissions } = health;
+ *
+ * authCategoryRWPermissions({
+ *   permissions: ['1', '2'],
+ *   success: () => {
+ *     console.log('authCategoryRWPermissions success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('authCategoryRWPermissions fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export declare const authCategoryRWPermissions: typeof ty.health.authCategoryRWPermissions;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { authCategoryRWPermissionsSync } = health;
+ *
+ * authCategoryRWPermissionsSync({
+ *   permissions: ['1', '2'],
+ * });
+ * ```
  */
 export declare const authCategoryRWPermissionsSync: typeof ty.health.authCategoryRWPermissionsSync;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { saveQuantityData } = health;
+ *
+ * saveQuantityData({
+ *   type: 1,
+ *   value: 65,
+ *   unitType: 'kg',
+ *   startTime: 1700000000,
+ *   endTime: 1700000060,
+ *   success: () => {
+ *     console.log('saveQuantityData success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('saveQuantityData fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export declare const saveQuantityData: typeof ty.health.saveQuantityData;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { saveQuantityDataSync } = health;
+ *
+ * saveQuantityDataSync({
+ *   type: 1,
+ *   value: 65,
+ *   unitType: 'kg',
+ *   startTime: 1700000000,
+ *   endTime: 1700000060,
+ * });
+ * ```
  */
 export declare const saveQuantityDataSync: typeof ty.health.saveQuantityDataSync;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { saveQuantityNoTimeWithData } = health;
+ *
+ * saveQuantityNoTimeWithData({
+ *   type: 1,
+ *   value: 65,
+ *   unitType: 'kg',
+ *   success: () => {
+ *     console.log('saveQuantityNoTimeWithData success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('saveQuantityNoTimeWithData fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export declare const saveQuantityNoTimeWithData: typeof ty.health.saveQuantityNoTimeWithData;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { saveQuantityNoTimeWithDataSync } = health;
+ *
+ * saveQuantityNoTimeWithDataSync({
+ *   type: 1,
+ *   value: 65,
+ *   unitType: 'kg',
+ * });
+ * ```
  */
 export declare const saveQuantityNoTimeWithDataSync: typeof ty.health.saveQuantityNoTimeWithDataSync;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { saveBloodPressureData } = health;
+ *
+ * saveBloodPressureData({
+ *   systolic: 120,
+ *   diastolic: 80,
+ *   startTime: 1700000000,
+ *   endTime: 1700000060,
+ *   success: () => {
+ *     console.log('saveBloodPressureData success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('saveBloodPressureData fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export declare const saveBloodPressureData: typeof ty.health.saveBloodPressureData;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { saveBloodPressureDataSync } = health;
+ *
+ * saveBloodPressureDataSync({
+ *   systolic: 120,
+ *   diastolic: 80,
+ *   startTime: 1700000000,
+ *   endTime: 1700000060,
+ * });
+ * ```
  */
 export declare const saveBloodPressureDataSync: typeof ty.health.saveBloodPressureDataSync;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { readQuantityDataWithType } = health;
+ *
+ * readQuantityDataWithType({
+ *   type: 1,
+ *   unitType: 'count',
+ *   startTime: 1700000000,
+ *   endTime: 1700086400,
+ *   success: (result) => {
+ *     console.log('readQuantityDataWithType success', result.value);
+ *   },
+ *   fail: (error) => {
+ *     console.log('readQuantityDataWithType fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export declare const readQuantityDataWithType: typeof ty.health.readQuantityDataWithType;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { readQuantityDataWithTypeSync } = health;
+ *
+ * const result = readQuantityDataWithTypeSync({
+ *   type: 1,
+ *   unitType: 'count',
+ *   startTime: 1700000000,
+ *   endTime: 1700086400,
+ * });
+ * console.log('readQuantityDataWithTypeSync result', result.value);
+ * ```
  */
 export declare const readQuantityDataWithTypeSync: typeof ty.health.readQuantityDataWithTypeSync;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { deleteQuantityDataType } = health;
+ *
+ * deleteQuantityDataType({
+ *   type: 1,
+ *   startTime: 1700000000,
+ *   endTime: 1700086400,
+ *   success: () => {
+ *     console.log('deleteQuantityDataType success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('deleteQuantityDataType fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export declare const deleteQuantityDataType: typeof ty.health.deleteQuantityDataType;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { deleteQuantityDataTypeSync } = health;
+ *
+ * deleteQuantityDataTypeSync({
+ *   type: 1,
+ *   startTime: 1700000000,
+ *   endTime: 1700086400,
+ * });
+ * ```
  */
 export declare const deleteQuantityDataTypeSync: typeof ty.health.deleteQuantityDataTypeSync;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { readCharacteristicDataWithType } = health;
+ *
+ * readCharacteristicDataWithType({
+ *   type: 1,
+ *   success: (result) => {
+ *     console.log('readCharacteristicDataWithType success', result.value);
+ *   },
+ *   fail: (error) => {
+ *     console.log('readCharacteristicDataWithType fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export declare const readCharacteristicDataWithType: typeof ty.health.readCharacteristicDataWithType;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { readCharacteristicDataWithTypeSync } = health;
+ *
+ * const result = readCharacteristicDataWithTypeSync({
+ *   type: 1,
+ * });
+ * console.log('readCharacteristicDataWithTypeSync result', result.value);
+ * ```
  */
 export declare const readCharacteristicDataWithTypeSync: typeof ty.health.readCharacteristicDataWithTypeSync;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { saveCategoryData } = health;
+ *
+ * saveCategoryData({
+ *   type: 1,
+ *   value: 1,
+ *   startTime: 1700000000,
+ *   endTime: 1700000060,
+ *   success: () => {
+ *     console.log('saveCategoryData success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('saveCategoryData fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export declare const saveCategoryData: typeof ty.health.saveCategoryData;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { saveCategoryDataSync } = health;
+ *
+ * saveCategoryDataSync({
+ *   type: 1,
+ *   value: 1,
+ *   startTime: 1700000000,
+ *   endTime: 1700000060,
+ * });
+ * ```
  */
 export declare const saveCategoryDataSync: typeof ty.health.saveCategoryDataSync;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { saveCategoryNoTimeWithData } = health;
+ *
+ * saveCategoryNoTimeWithData({
+ *   type: 1,
+ *   value: 1,
+ *   success: () => {
+ *     console.log('saveCategoryNoTimeWithData success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('saveCategoryNoTimeWithData fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export declare const saveCategoryNoTimeWithData: typeof ty.health.saveCategoryNoTimeWithData;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { saveCategoryNoTimeWithDataSync } = health;
+ *
+ * saveCategoryNoTimeWithDataSync({
+ *   type: 1,
+ *   value: 1,
+ * });
+ * ```
  */
 export declare const saveCategoryNoTimeWithDataSync: typeof ty.health.saveCategoryNoTimeWithDataSync;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { readCategoryDataWithType } = health;
+ *
+ * readCategoryDataWithType({
+ *   type: 1,
+ *   startTime: 1700000000,
+ *   endTime: 1700086400,
+ *   success: (result) => {
+ *     console.log('readCategoryDataWithType success', result.value);
+ *   },
+ *   fail: (error) => {
+ *     console.log('readCategoryDataWithType fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export declare const readCategoryDataWithType: typeof ty.health.readCategoryDataWithType;
 /**
  * @public
  * @since @ray-js/ray 1.6.17
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { readCategoryDataWithTypeSync } = health;
+ *
+ * const result = readCategoryDataWithTypeSync({
+ *   type: 1,
+ *   startTime: 1700000000,
+ *   endTime: 1700086400,
+ * });
+ * console.log('readCategoryDataWithTypeSync result', result.value);
+ * ```
  */
 export declare const readCategoryDataWithTypeSync: typeof ty.health.readCategoryDataWithTypeSync;
 /**
  * @public
  * @since @ray-js/ray 1.7.4
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { queryBodyFatScaleAlgorithm } = health;
+ *
+ * queryBodyFatScaleAlgorithm({
+ *   sex: 1,
+ *   weight: 70,
+ *   imp: 500,
+ *   height: 175,
+ *   birthday: 946684800000,
+ *   time: 1700000000000,
+ *   success: (result) => {
+ *     console.log('queryBodyFatScaleAlgorithm success', result.bmi, result.fat);
+ *   },
+ *   fail: (error) => {
+ *     console.log('queryBodyFatScaleAlgorithm fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export declare const queryBodyFatScaleAlgorithm: typeof ty.health.queryBodyFatScaleAlgorithm;
 /**
  * @public
  * @since @ray-js/ray 1.7.4
+ * @example 基础调用
+ * ```tsx
+ * import { health } from '@ray-js/ray';
+ *
+ * const { queryBodyFatScaleAlgorithmSync } = health;
+ *
+ * const result = queryBodyFatScaleAlgorithmSync({
+ *   sex: 1,
+ *   weight: 70,
+ *   imp: 500,
+ *   height: 175,
+ *   birthday: 946684800000,
+ *   time: 1700000000000,
+ * });
+ * console.log('queryBodyFatScaleAlgorithmSync result', result.bmi, result.fat);
+ * ```
  */
 export declare const queryBodyFatScaleAlgorithmSync: typeof ty.health.queryBodyFatScaleAlgorithmSync;