@octokit/webhooks-types

v7.6.1

Generated TypeScript definitions based on community contributed JSON Schemas For more information about how to use this package see README

Latest version published 3 months ago

License: MIT

NPM

GitHub

Package Health Score

89 / 100

security
No known security issues
popularity
Influential project
maintenance
Healthy
community
Sustainable

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
7.6.1	\|	10/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
7.5.1	\|	04/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
6.11.0	\|	04/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
6.3.6	\|	08/2022	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.8.0	\|	06/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Influential project

Weekly Downloads (1,054,560)

GitHub Stars: 231
Forks: 42
Contributors: -

Direct Usage Popularity

The npm package @octokit/webhooks-types receives a total of 1,054,560 downloads a week. As such, we scored @octokit/webhooks-types popularity level to be Influential project.

Based on project statistics from the GitHub repository for the npm package @octokit/webhooks-types, we found that it has been starred 231 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 0
Funding: No

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 8
Open PR: 2
Last Release: 3 months ago
Last Commit: 1 month ago

Further analysis of the maintenance status of @octokit/webhooks-types based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @octokit/webhooks-types demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 4 years
Dependencies: 0 Direct
Versions: 112
Install Size: 223 kB
Dist-tags: 2
# of Files: 3
Maintainers: 4
TS Typings: No

@octokit/webhooks-types has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Octokit Webhooks

machine-readable, always up-to-date GitHub Webhooks specifications

Update status

Download

Download the latest specification at octokit.github.io/webhooks/payload-examples/api.github.com/index.json

Usage

This package ships with types for the webhook events generated from the respective json schemas, which you can use like so:

import { WebhookEvent, IssuesOpenedEvent } from "@octokit/webhooks-types";

const handleWebhookEvent = (event: WebhookEvent) => {
  if ("action" in event && event.action === "completed") {
    console.log(`${event.sender.login} completed something!`);
  }
};

const handleIssuesOpenedEvent = (event: IssuesOpenedEvent) => {
  console.log(
    `${event.sender.login} opened "${event.issue.title}" on ${event.repository.full_name}`,
  );
};

⚠️ Caution ⚠️: Webhooks Types are expected to be used with the strictNullChecks option enabled in your tsconfig. If you don't have this option enabled, there's the possibility that you get never as the inferred type in some use cases. See #395 for details.

LICENSE

MIT

FAQs

What is @octokit/webhooks-types?

Generated TypeScript definitions based on community contributed JSON Schemas. Visit Snyk Advisor to see a full health score report for @octokit/webhooks-types, including popularity, security, maintenance & community analysis.

Is @octokit/webhooks-types popular?

The npm package @octokit/webhooks-types receives a total of 1,054,560 weekly downloads. As such, @octokit/webhooks-types popularity was classified as an influential project. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @octokit/webhooks-types well maintained?

We found that @octokit/webhooks-types demonstrated a healthy version release cadence and project activity. It has a community of 0 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @octokit/webhooks-types safe to use?

The npm package @octokit/webhooks-types was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 24 November-2024, at 06:09 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

@octokit/webhooks-types

Generated TypeScript definitions based on community contributed JSON Schemas For more information about how to use this package see README

Ensure you're using the healthiest npm packages

Package Health Score

Security

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Popularity

Weekly Downloads (1,054,560)

Direct Usage Popularity

Community

Embed Package Health Score Badge

Maintenance

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Package

Readme

Octokit Webhooks

Download

Usage

See also

LICENSE

FAQs

What is @octokit/webhooks-types?

Is @octokit/webhooks-types popular?

Is @octokit/webhooks-types well maintained?

Is @octokit/webhooks-types safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (1,054,560)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Octokit Webhooks

Download

Usage

See also

LICENSE

FAQs

What is @octokit/webhooks-types?

Is @octokit/webhooks-types popular?

Is @octokit/webhooks-types well maintained?

Is @octokit/webhooks-types safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues