Gathering detailed insights and metrics for miniprogram-api-typings
Gathering detailed insights and metrics for miniprogram-api-typings
Type definitions for APIs of Wechat Mini Program in TypeScript
Installations
npm install miniprogram-api-typingsReleases
Unable to fetch releases
Developer
wechat-miniprogram
Developer Guide
BETA
Module System
CommonJS
Min. Node Version
Typescript Support
Yes
Node Version
20.16.0
NPM Version
10.8.1
Statistics
743 Stars
201 Commits
112 Forks
17 Watching
4 Branches
17 Contributors
Updated on 28 Nov 2024
Languages
TypeScript (98.48%)
JavaScript (1.52%)
Total Downloads
Cumulative downloads
Total Downloads
18,954,399
Last day
-23.9%
18,476
Compared to previous day
Last week
-35.1%
115,221
Compared to previous week
Last month
40.4%
512,911
Compared to previous month
Last year
-29.7%
4,616,662
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Versions
微信小程序定义文件
微信小程序 API 的 TypeScript 类型定义文件
安装
通过独立 npm 包
1npm install miniprogram-api-typings
安装后手动导入：
import 'miniprogram-api-typings';
或者在 ts 配置中指定：
- 在
tsconfig.json中指定types: ["miniprogram-api-typings"]
或者通过 三斜杠指令 引用：
/// <reference path="node_modules/miniprogram-api-typings/index.d.ts" />
或：
通过 DefinitelyTyped
1npm install @types/wechat-miniprogram
更新日志
参考 CHANGELOG.md
贡献
API 的定义文件（lib.wx.api.d.ts）是随 文档 一起自动生成的，如果发现了 API 接口的定义错误，请提一个 issue 给我们，关于 API 的 PR 将 不会 被接受。
如果有针对页面（Page）、自定义组件（Component）等接口的 bug 和建议，欢迎 PR 或提一个 issue 给我们。非常感谢！
贡献者
测试
本定义文件使用 tsd 进行测试，所有的测试样例放在 test 目录下。
想执行测试的话，克隆本项目并完成 npm install --save-dev 后执行 npm test 即可。
如果您发现了不能通过自动化测试的测试样例，可以提交 PR 或者提一个 issue。当然，能通过自动化测试的强有力的测试样例也是欢迎的。
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
27 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
3 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
Reason
Found 3/12 approved changesets -- score normalized to 2
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/test.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/wechat-miniprogram/api-typings/test.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/wechat-miniprogram/api-typings/test.yml/master?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/test.yml:26
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 npmCommand dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
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
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
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 21 are checked with a SAST tool
Score
4.3
/10
Last Scanned on 2024-11-18
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