Gathering detailed insights and metrics for @capacitor-community/keep-awake
Gathering detailed insights and metrics for @capacitor-community/keep-awake
Installations
npm install @capacitor-community/keep-awakeDeveloper
capacitor-community
Developer Guide
BETA
Module System
CommonJS
Min. Node Version
Typescript Support
Yes
Node Version
18.16.0
NPM Version
9.8.1
Statistics
126 Stars
72 Commits
16 Forks
11 Watching
7 Branches
22 Contributors
Updated on 01 Nov 2024
Bundle Size
382.00 B
Minified
266.00 B
Minified + Gzipped
Languages
Java (32.16%)
TypeScript (26.44%)
Swift (18.92%)
Ruby (9.39%)
Objective-C (8.51%)
JavaScript (4.58%)
Total Downloads
Cumulative downloads
Total Downloads
1,355,570
Last day
-14.7%
2,675
Compared to previous day
Last week
4.7%
18,060
Compared to previous week
Last month
5.1%
78,843
Compared to previous month
Last year
42.7%
627,316
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
1
Versions
Keep Awake
@capacitor-community/keep-awake
⚡️ Capacitor plugin to prevent devices from dimming or locking the screen.
Maintainers
| Maintainer | GitHub | Social |
|---|---|---|
| Kevin Boosten | kevinboosten | @kevinboosten |
| Robin Genz | robingenz | @robin_genz |
Installation
1npm install @capacitor-community/keep-awake 2npx cap sync
Configuration
No configuration required for this plugin.
Demo
A working example can be found here: robingenz/capacitor-plugin-demo
Usage
1import { KeepAwake } from '@capacitor-community/keep-awake'; 2 3const keepAwake = async () => { 4 await KeepAwake.keepAwake(); 5}; 6 7const allowSleep = async () => { 8 await KeepAwake.allowSleep(); 9}; 10 11const isSupported = async () => { 12 const result = await KeepAwake.isSupported(); 13 return result.isSupported; 14}; 15 16const isKeptAwake = async () => { 17 const result = await KeepAwake.isKeptAwake(); 18 return result.isKeptAwake; 19};
API
keepAwake()
1keepAwake() => Promise<void>
Prevent the device from dimming the screen.
allowSleep()
1allowSleep() => Promise<void>
Allow the device to dim the screen.
isSupported()
1isSupported() => Promise<IsSupportedResult>
Whether keep awake is supported or not.
Returns: Promise<IsSupportedResult>
isKeptAwake()
1isKeptAwake() => Promise<IsKeptAwakeResult>
Check if the device is kept awake.
Returns: Promise<IsKeptAwakeResult>
Interfaces
IsSupportedResult
| Prop | Type |
|---|---|
isSupported | boolean |
IsKeptAwakeResult
| Prop | Type |
|---|---|
isKeptAwake | boolean |
Changelog
See CHANGELOG.md.
License
See LICENSE.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
binaries present in source code
Details
- Warn: binary detected: android/gradle/wrapper/gradle-wrapper.jar:1
Reason
6 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Reason
dependency not pinned by hash detected -- score normalized to 3
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/capacitor-community/keep-awake/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/capacitor-community/keep-awake/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/capacitor-community/keep-awake/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/capacitor-community/keep-awake/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/capacitor-community/keep-awake/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/capacitor-community/keep-awake/ci.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/lock.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/capacitor-community/keep-awake/lock.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/needs-reply-remove.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/capacitor-community/keep-awake/needs-reply-remove.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/needs-reply.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/capacitor-community/keep-awake/needs-reply.yml/master?enable=pin
- Info: 0 out of 6 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 3 third-party GitHubAction dependencies pinned
- Info: 2 out of 2 npmCommand dependencies pinned
Reason
Found 4/24 approved changesets -- score normalized to 1
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/ci.yml:1
- Warn: no topLevel permission defined: .github/workflows/needs-reply-remove.yml:1
- Warn: no topLevel permission defined: .github/workflows/needs-reply.yml:1
- Warn: no topLevel permission defined: .github/workflows/needs-triage.yml:1
- Info: no jobLevel write permissions found
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 14 are checked with a SAST tool
Score
3.1
/10
Last Scanned on 2024-11-25
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More