Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@octokit/types

Package Overview
Dependencies
Maintainers
3
Versions
211
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@octokit/types

Shared TypeScript definitions for Octokit projects

  • 2.10.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
18M
increased by0.52%
Maintainers
3
Weekly downloads
 
Created

What is @octokit/types?

The @octokit/types npm package provides TypeScript definitions for GitHub's REST API, GraphQL API, and Webhooks. It is designed to be used with other Octokit libraries to offer type safety and auto-completion in code editors, making it easier to work with GitHub's APIs in a TypeScript project.

What are @octokit/types's main functionalities?

GitHub REST API Types

Provides types for responses from GitHub's REST API endpoints. This example shows how to type an object representing a GitHub issue as it would be returned from the REST API.

import { RestEndpointMethodTypes } from '@octokit/types';

const issue: RestEndpointMethodTypes['issues']['get']['response']['data'] = {
  id: 1,
  number: 1347,
  title: 'Just a test issue'
};

GitHub GraphQL API Types

Provides types for constructing and receiving responses from GitHub's GraphQL API. This example demonstrates fetching a repository's details using GraphQL and typing the response.

import { graphql } from '@octokit/graphql';
import { Repository } from '@octokit/types';

async function getRepository(owner: string, name: string): Promise<Repository> {
  const { repository } = await graphql<{ repository: Repository }>(
    `{
      repository(owner: "${owner}", name: "${name}") {
        id
        name
        owner {
          login
        }
      }
    }`
  );
  return repository;
}

GitHub Webhooks Types

Includes types for GitHub Webhook events. This example shows how to handle an incoming webhook event with type safety, specifically for an issue event.

import { WebhookEvent } from '@octokit/types';

function handleWebhook(event: WebhookEvent) {
  if (event.name === 'issues') {
    const action = event.payload.action;
    console.log(`Issue action: ${action}`);
  }
}
0

Keywords

FAQs

Package last updated on 16 Apr 2020

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc