@octokit/graphql

@octokit/graphql

Version 8.1.1
Published 31 minutes ago
28.9 kB
3 dependencies
MIT license

Install

npm i @octokit/graphql

yarn add @octokit/graphql

pnpm add @octokit/graphql

Overview

GitHub GraphQL API client for browsers and Node

Index

Variables

variable graphql

const graphql: graphql;

Functions

function withCustomRequest

withCustomRequest: (customRequest: any) => import('./types.js').graphql;

Classes

class GraphqlResponseError

class GraphqlResponseError<ResponseData> extends Error {}

constructor

constructor(
    request: any,
    headers: ResponseHeaders,
    response: Required<GraphQlQueryResponse<ResponseData>>
);

property data

readonly data: {};

property errors

readonly errors: [
    {
        type: string;
        message: string;
        path: [string];
        extensions: { [key: string]: any };
        locations: [{ line: number; column: number }];
    }
];

property headers

readonly headers: ResponseHeaders;

property name

name: string;

property request

readonly request: any;

property response

readonly response: Required<GraphQlQueryResponse<ResponseData>>;

Type Aliases

type GraphQlQueryResponseData

type GraphQlQueryResponseData = {
    [key: string]: any;
};

Package Files (3)

Dependencies (3)

Dev Dependencies (12)

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@octokit/graphql.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@octokit/graphql)

HTML

<a href="https://www.jsdocs.io/package/@octokit/graphql"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated just now.
Package analyzed in 1813 ms.
Missing or incorrect documentation? Open an issue for this package.