Security News
Weekly Downloads Now Available in npm Package Search Results
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
@companycam/vibe-check
Advanced tools
Welcome to the CompanyCam Vibe Check repo.
This library is largely for exposing hardware information not readily available. Maintaining a high level of performance in our apps is a large priority. Sometimes we can compensate for these issues, and sometimes we cannot. This library aims to expose hardware information commonly related to performance issues.
This library exposes the following information, through the getCurrentVibes
method:
{
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 Version: 15.0
minSdkVersion: 24
import { getCurrentVibes, FullVibeCheck } from '@companycam/vibe-check';
// ...elsewhere in your code
const vibes: FullVibeCheck = yield call(getCurrentVibes);
Gets the device's current hardware information. This method is the main entry point for this library. Returns all of the results from the other functions this library exposes.
import { getCurrentVibes, FullVibeCheck } from '@companycam/vibe-check';
const vibes: FullVibeCheck = yield call(getCurrentVibes);
This method will return an object very similar to the below JSON object:
{
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',
};
Gets the device's current Battery information.
import { VibeChecker } from '@companycam/companycam-vibe-check';
const { battery } = await NativeModules.VibeChecker.getBatteryVibe();
This method will return an object very similar to the below JSON object:
battery: {
batteryLevel: 0.5,
batteryState: 'unplugged',
lowPowerMode: false,
isBatteryCharging: false,
}
Gets the device's current Network Connection information.
import { getConnectionInfo } from '@companycam/vibe-check';
const { connection } = await getConnectionInfo();
This method will return an object very similar to the below JSON object:
connection: {
isConnected: true,
isInternetReachable: true,
type: 'cellular',
details: {
isConnectionExpensive: false,
cellularGeneration: '4g',
},
}
Gets the device's current RAM usage, as a percentage.
import { getRamUsage } from '@companycam/vibe-check';
const { ramUsage } = await getRamUsage();
This method will return an object very similar to the below JSON object:
ramUsage: 0.8; // <-- percentage
Gets the device's current thermal state.
import { getThermalState } from '@companycam/vibe-check';
const { thermalState } = await getThermalState();
This method will return an object very similar to the below JSON object:
thermalState: 'fair';
📝 NOTE: Since iOS
and Android
expose different thermal states, we've normalized them. Currently we use iOS
nomenclature for the different thermal states. Please refer to the table below.
thermalState | iOS Value | Android Value |
---|---|---|
nominal | nominal | THERMAL_STATUS_NONE / THERMAL_STATUS_LIGHT |
fair | fair | THERMAL_STATUS_MODERATE |
serious | serious | THERMAL_STATUS_SEVERE |
critical | critical | THERMAL_STATUS_CRITICAL / THERMAL_STATUS_EMERGENCY |
unknown | unknown | unknown |
Property | Type | Description |
---|---|---|
batteryLevel | number | The battery level on the device, from 0.0 to 1.0 |
batteryState | string | unknown , unplugged , charging , full |
lowPowerMode | bool | Whether or not the device is in low power mode |
Property | Type | Description |
---|---|---|
isConnected | bool | Whether or not the device is connected to the internet |
isInternetReachable | bool | Whether or not the device is connected to the internet |
type | string | none , unknown , cellular , wifi , bluetooth , ethernet , wimax , vpn |
details | object | See below |
Property | Type | Description |
---|---|---|
isConnectionExpensive | bool | Whether or not the connection is expensive |
cellularGeneration | string | 2g , 3g , 4g , 5g , unknown |
Property | Type | Description |
---|---|---|
thermalState | string | nominal , fair , serious , critical |
Property | Type | Description |
---|---|---|
ramUsage | number | RAM Usage on the device from 0.0 to 1.0 |
This project uses conventional commits and semantic-release to automate the release process. Please follow the conventional commits format when making commits.
See the contributing guide to learn how to contribute to the repository and the development workflow.
Made with create-react-native-library
FAQs
Hardware logging library for CompanyCam
We found that @companycam/vibe-check demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 73 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.