npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@afosto/graphql-client

v3.0.0

Published

Afosto GraphQL client

Downloads

344

Readme

Installation

# Install with Yarn
yarn add @afosto/graphql-client graphql

# Install with NPM
npm install @afosto/graphql-client graphql

Basic usage

import { graphQLClient, gql } from '@afosto/graphql-client';

// For authentication
graphQLClient.setAuthorizationHeader('AUTH_TOKEN');

// Your graphQL query and variables.
const query = gql``; 
const variables = {};

// Request
await graphQLClient.request(query, variables);

Custom configuration

If you would like to use the GraphQLClient with other configuration than the default configuration.

| Option | Description | Default | |-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| | url | The base url for the client. | https://afosto.app/graphql | | convertResponseToCamelCase | Whether to convert the response data to camel case. | true |
| convertVariablesToSnakeCase | Whether to convert the variables to snake case. | true | |
| excludeConversionKeys | Set the keys that should be excluded from being converted to camel case and snake case. | [] | |
| stopPaths | Exclude children at the given object paths in dot-notation from being converted to camel case. Note: Is not yet implemented for snake case conversion | [] | |

import { createGraphQLClient } from '@afosto/graphql-client';

const client = createGraphQLClient({
  // Your configuration.
});

// For authentication
client.setAuthorizationHeader('AUTH_TOKEN');

// Your graphQL query and variables.
const query = gql``;
const variables = {};

// Request
await client.request(query, variables);

Default response transformation

By default the Afosto GraphQLClient will transform the response keys to camel case and the variable keys to snake case. If you would like to change these settings, you can do the following:

Default client

graphQLClient.setConvertResponseToCamelCase(false);
graphQLClient.setConvertVariablesToSnakeCase(false);

Custom client

import { createGraphQLClient } from '@afosto/graphql-client';

const client = createGraphQLClient({
  // Your configuration.
  convertResponseToCamelCase: false,
  convertVariablesToSnakeCase: false,
});

// Or after client initialization
client.setConvertResponseToCamelCase(false);
client.setConvertVariablesToSnakeCase(false);

Custom response transformation

If you would like to alter the response data yourself, you can use the following:

await graphQLClient.request(query, variables, {
  transformResponse: [
    response => {
      // Alter and return your new response data.
      return response;
    },
  ],
});

Compatibility

  • Node >= 18