Security News
JavaScript Leaders Demand Oracle Release the JavaScript Trademark
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
@octokit/types
Advanced tools
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.
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}`);
}
}
Shared TypeScript definitions for Octokit projects
See all exported types at https://octokit.github.io/types.ts
import { Endpoints } from "@octokit/types";
type listUserReposParameters = Endpoints["GET /repos/{owner}/{repo}"]["parameters"];
type listUserReposResponse = Endpoints["GET /repos/{owner}/{repo}"]["response"];
async function listRepos(
options: listUserReposParameters
): listUserReposResponse["data"] {
// ...
}
import {
GetResponseTypeFromEndpointMethod,
GetResponseDataTypeFromEndpointMethod,
} from "@octokit/types";
import { Octokit } from "@octokit/rest";
const octokit = new Octokit();
type CreateLabelResponseType = GetResponseTypeFromEndpointMethod<
typeof octokit.issues.createLabel
>;
type CreateLabelResponseDataType = GetResponseDataTypeFromEndpointMethod<
typeof octokit.issues.createLabel
>;
See CONTRIBUTING.md
FAQs
Shared TypeScript definitions for Octokit projects
We found that @octokit/types demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 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
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.