http-link-dataloader

  • Version 0.1.6
  • Published
  • 30.7 kB
  • 3 dependencies
  • MIT license

Install

npm i http-link-dataloader
yarn add http-link-dataloader
pnpm add http-link-dataloader

Overview

[![CircleCI](https://circleci.com/gh/graphcool/http-link-dataloader.svg?style=shield)](https://circleci.com/gh/graphcool/http-link-dataloader) [![npm version](https://badge.fury.io/js/http-link-dataloader.svg)](https://badge.fury.io/js/http-link-dataloade

Index

Classes

class BatchedGraphQLClient

class BatchedGraphQLClient {}

    constructor

    constructor(uri: string, options?: Options & ClientOptions);

      property load

      load: (keys: string[]) => Promise<any>;

        property options

        options: Options;

          property uri

          uri: string;

            method request

            request: <T extends unknown>(
            query: string,
            variables?: Variables,
            operationName?: string
            ) => Promise<T>;

              class HTTPLinkDataloader

              class HTTPLinkDataloader extends ApolloLink {}

                constructor

                constructor(options: HttpOptions);

                  Interfaces

                  interface ClientOptions

                  interface ClientOptions {}

                    property cacheResults

                    cacheResults?: boolean;

                      interface GraphQLError

                      interface GraphQLError {}

                        property locations

                        locations?: {
                        line: number;
                        column: number;
                        }[];

                          property message

                          message: string;

                            property path

                            path?: string[];

                              interface GraphQLRequestContext

                              interface GraphQLRequestContext {}

                                property query

                                query: string;

                                  property variables

                                  variables?: Variables;

                                    interface GraphQLResponse

                                    interface GraphQLResponse {}

                                      property data

                                      data?: any;

                                        property errors

                                        errors?: GraphQLError[];

                                          property status

                                          status: number;

                                            index signature

                                            [key: string]: any;

                                              interface Options

                                              interface Options {}

                                                property cache

                                                cache?: RequestInit['cache'];

                                                  property credentials

                                                  credentials?: RequestInit['credentials'];

                                                    property headers

                                                    headers?: {
                                                    [key: string]: string;
                                                    };

                                                      property integrity

                                                      integrity?: RequestInit['integrity'];

                                                        property keepalive

                                                        keepalive?: boolean;

                                                          property method

                                                          method?: RequestInit['method'];

                                                            property mode

                                                            mode?: RequestInit['mode'];

                                                              property redirect

                                                              redirect?: RequestInit['redirect'];

                                                                property referrer

                                                                referrer?: RequestInit['referrer'];

                                                                  property referrerPolicy

                                                                  referrerPolicy?: RequestInit['referrerPolicy'];

                                                                    Type Aliases

                                                                    type HttpOptions

                                                                    type HttpOptions = Options & {
                                                                    uri: string;
                                                                    };

                                                                      type Variables

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

                                                                        Package Files (4)

                                                                        Dependencies (3)

                                                                        Dev Dependencies (10)

                                                                        Peer Dependencies (0)

                                                                        No peer dependencies.

                                                                        Badge

                                                                        To add a badge like this onejsDocs.io badgeto 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/http-link-dataloader.

                                                                        • Markdown
                                                                          [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/http-link-dataloader)
                                                                        • HTML
                                                                          <a href="https://www.jsdocs.io/package/http-link-dataloader"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>