@companycam/vibe-检查

CompanyCam 的硬件记录库

欢迎来到Cam Vibe Check Repo公司.

该图书馆主要用于披露不易获得的硬件信息。 在我们的应用中保持高水平的性能是一大优先事项. 有时我们可以补偿这些问题,有时我们无法。 该图书馆旨在揭露通常与性能问题有关的硬件信息.

该图书馆通过图书馆披露以下信息: getCurrentVibes 方法 :

{
  battery: {
    batteryLevel: 0.70202270953611340,
    batteryState: 'charging',
    lowPowerMode: false,
  },
  connectivity: {
    connection: {
      isConnected: true,
      isInternetReachable: true,
      type: 'cellular',
      details: {
        isConnectionExpensive: false,
        cellularGeneration: '4g',
      },
    },
  },
  memoryInUse: 83193856,
  thermalState: 'nominal',
};

安装

yarn install @companycam/vibe-check

yarn add @companycam/vibe-check

系统要求

iOS系统

iOS Version: 15.0

机器人

minSdkVersion: 24

使用量

import { getCurrentVibes, FullVibeCheck } from '@companycam/vibe-check';

// ...elsewhere in your code

const vibes: FullVibeCheck = yield call(getCurrentVibes);

API 密码

方法

获取当前维布斯( )

获取设备当前硬件信息 。 这种方法是这个库的主要切入点. 返回此库所显示的其他函数的全部结果 .

import { getCurrentVibes, FullVibeCheck } from '@companycam/vibe-check';

const vibes: FullVibeCheck = yield call(getCurrentVibes);

此方法将返回一个与以下 JSON 对象非常相近的对象 :

{
  battery: {
    batteryLevel: 0.70202270953611340,
    batteryState: 'charging',
    lowPowerMode: false,
  },
  connectivity: {
    connection: {
      isConnected: true,
      isInternetReachable: true,
      type: 'cellular',
      details: {
        isConnectionExpensive: false,
        cellularGeneration: '4g',
      },
    },
  },
  memoryInUse: 83193856,
  thermalState: 'nominal',
};

获得Batterry Vibe ()

获取设备当前电池信息.

import { VibeChecker } from '@companycam/companycam-vibe-check';

const { battery } = await NativeModules.VibeChecker.getBatteryVibe();

此方法将返回一个与以下 JSON 对象非常相近的对象 :

  battery: {
    batteryLevel: 0.5,
    batteryState: 'unplugged',
    lowPowerMode: false,
    isBatteryCharging: false,
  }

获取连接Info ()

获取设备当前网络连接信息 .

import { getConnectionInfo } from '@companycam/vibe-check';

const { connection } = await getConnectionInfo();

此方法将返回一个与以下 JSON 对象非常相近的对象 :

  connection: {
    isConnected: true,
    isInternetReachable: true,
    type: 'cellular',
    details: {
      isConnectionExpensive: false,
      cellularGeneration: '4g',
    },
  }

获取 RamUsage ()

获得设备当前内存的使用率, 百分比 .

import { getRamUsage } from '@companycam/vibe-check';

const { ramUsage } = await getRamUsage();

此方法将返回一个与以下 JSON 对象非常相近的对象 :

ramUsage: 0.8; // <-- percentage

获得热态 ()

获得设备当前热能状态.

import { getThermalState } from '@companycam/vibe-check';

const { thermalState } = await getThermalState();

此方法将返回一个与以下 JSON 对象非常相近的对象 :

thermalState: 'fair';

注:自 iOS 财务报告和审定财务报表 Android 暴露不同的热能状态,我们已经把它们正常化了。 目前我们使用 iOS 不同热态的术语。 请参看下表.

返回对象潜在值

电池

连通性

连接细节

热态

内存使用

捐款

该项目使用常规承诺和语义释放使释放过程自动化。 请跟随 常规承诺 格式中输入.

见 贡献指南 学习如何为储存库和发展工作流程作出贡献.

制造的 创建- 反应- 本土- 图书馆