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

@uplift-ltd/apollo

v6.1.0

Published

Apollo helpers.

Downloads

174

Readme

@uplift-ltd/apollo

Installation

npm i --save @uplift-ltd/apollo

API

useEnhancedQuery

Same API as Apollo useQuery except:

  • It returns initialLoading, refetching, and fetchingMore (pass in notifyOnNetworkStatusChange: true)
import { useEnhancedQuery } from "@uplift-ltd/apollo";

useEnhancedQuery<MyQuery, MyQueryVariables>(MY_QUERY, { variables }, { auth: false });

See Apollo useQuery docs.

const { data, initialLoading, refetching, fetchingMore } = useEnhancedQuery(MY_QUERY, { notifyOnNetworkStatusChange: true};

useEnhancedLazyQuery

Same as Apollo useLazyQuery.

import { useEnhancedLazyQuery } from "@uplift-ltd/apollo";

useEnhancedLazyQuery<MyQuery, MyQueryVariables>(MY_QUERY, { variables });

See Apollo useLazyQuery docs.

useEnhancedMutation

Same as Apollo useMutation.

import { useEnhancedMutation } from "@uplift-ltd/apollo";

useEnhancedMutation<MyMutation, MyMutationVariables>(MY_MUTATION, { variables }, { auth: false });

Apollo useMutation docs.

useEnumValues

Fetch key and descriptions for an enum from the gql server. Providing a type for the enum will give correct data on the response type.

Note that introspection needs to be enabled for this to work.

import { useEnumValues } from "@uplift-ltd/apollo";

const colors = useEnumValues<MyColors>("MyColors");

console.log(colors); // => { BLUE: "Brand Blue", RED: "Danger Red" }

initClient

Configure Apollo client.

import { InMemoryCache } from "@apollo/client";
import { initClient } from "@uplift-ltd/apollo";

const cache = new InMemoryCache();

const client = initClient({
  cache,
  uri: `/api/graphql`,
});

getQueryName

Get the query or mutation name.

import { getQueryName } from "@uplift-ltd/apollo";

const CURRENT_USER_QUERY = gql`
  query CurrentUser {
    me {
      id
    }
  }
`;

const CurrentUserQueryName = getQueryName(CURRENT_USER_QUERY);

expect(CurrentUserQueryName).toEqual("CurrentUser");

getQueryBody

Get the query or mutation body.

import { getQueryBody } from "@uplift-ltd/apollo";

const CURRENT_USER_QUERY = gql`
  query CurrentUser {
    me {
      id
    }
  }
`;

const CurrentUserQueryBody = getQueryBody(CURRENT_USER_QUERY);

const EXPECTED_BODY = `
  query CurrentUser {
    me {
      id
    }
  }
`;

expect(CurrentUserQueryBody).toEqual(EXPECTED_BODY);

useSkipVariables

Problem: Apollo's API makes it (currently) impossible for typescript to determine that variables can't be potentially undefined. For example this:

const organizationSlug = "o";
const commentId = "c" as string | undefined;

const { data } = useQuery(InstanceCommentPageDocument, {
  // Error: Type 'string | undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'.ts(2322)
  variables: { organizationSlug, commentId },
  ssr: false,
  skip: !commentId,
});

This hook helps handle skippable variables.

const organizationSlug = "o";
const commentId = "c" as string | undefined;

const [skip, skipVariables] = useSkipVariables({ commentId });

const { data } = useQuery(InstanceCommentPageDocument, {
  variables: { organizationSlug, ...skipVariables },
  ssr: false,
  skip,
});

Note: Do not use skipVariables in any other case since the hook does not actually map the values, it relies on apollo skipping the query if any of the passed in variables are null or undefined.