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

@soie/fetcher

v1.1.1

Published

Easily manage RESTful and GraphQL HTTP requests

Downloads

12

Readme

@soie/fetcher

The @soie/fetcher library is a straightforward set of fetch utilities. It facilitates easy usage of both RESTful and GraphQL HTTP requests and is compatible with all modern browsers and Node.js 18+.

Table of content

Installation

Using npm:

npm i @soie/fetcher

Using yarn:

yarn add @soie/fetcher

Using pnpm:

pnpm add @soie/fetcher

createFetcher

Configuration Options

  • timeout
    • Specifies the timeout in milliseconds before a request times out. If the request takes longer than the timeout, it will be aborted.
    • type: number
    • default: undefined
  • baseURL
    • Prepends the baseURL to the URL unless the URL is absolute.
    • type: string
    • default: ''
  • headers
    • Allows you to add headers to every request. It can be a Headers object or an object literal with string values.
    • type: Header or object literal with String { "key": "value"}
    • default: undefined

fetcher(url: string, init?: RequestInit)

import { createFetcher } from '@soie/fetcher'

const fetcher = createFetcher({
  timeout: 3000,
  baseURL: 'https://pokeapi.co/api/v2',
  headers: {
    Authorization: `Bearer ${your token}`,
  }
})

const getPokemonList = async () => {
  const { data } = await fetcher('/pokemon')
  return data
}
  • response
    • No need to use response.json(), as the fetcher maps response data into:
    • status
      • The status code of the response
      • type: number
    • statusText
      • The status message corresponding to the status code
      • type: string
    • header
      • The Headers object associated with the response.
      • type: Headers
      • Use headers.get('your header key') to get the header's value.
    • data
      • The API response body in JSON format
  • errors
    • If there is a request error, it will always return an error object
    • status
      • The status code of the response
      • type: number
    • statusText
      • The status message corresponding to the status code
      • type: string
    • header
      • The Headers object associated with the response.
      • type: Headers
      • Use headers.get('your header key') to get the header's value
    • message
      • If response.message can be parsed by JSON.parse, it will return the parsed object; otherwise, it returns a string

Using with TypeScript

import { createFetcher } from '@soie/fetcher'

type PokemonList = {
  // ...
}

const fetcher = createFetcher({
  timeout: 3000,
  baseURL: 'https://pokeapi.co/api/v2',
  headers: {
    Authorization: `Bearer ${your token}`,
  }
})

const getPokemonList = async (): Promise<PokemonList> => {
  const { data } = await fetcher<PokemonList>('/pokemon')
  return data
}

createGraphQLFetcher

Configuration Options

import { createGraphQLFetcher } from '@soie/fetcher'

const graphQLFetcher = createGraphQLFetcher({
  timeout: 3000,
  baseURL: 'https://beta.pokeapi.co',
  headers: {
    Authorization: `Bearer ${your token}`,
  }
})
  • timeout
    • Specifies the timeout in milliseconds before a request times out
    • If the request takes longer than the timeout, it will be aborted.
    • type: number
    • default: undefined
  • baseURL
    • Prepends the baseURL to the URL unless the URL is absolute.
    • type: string
    • default: ''
  • headers
    • Allows you to add headers to every request. It can be a Headers object or an object literal with string values.
    • type: Header or object literal with String { "key": "value"}
    • default: undefined

graphQLFetcher(url: string, init?: RequestInit excluding 'method')

  • url
  • init
    • RequestInit MDN
    • In graphQLFetcher, method is always set to POST, so you don't need to pass it.
import { createGraphQLFetcher } from '@soie/fetcher'

const graphQLFetcher = createGraphQLFetcher({
  timeout: 3000,
  baseURL: 'https://beta.pokeapi.co',
  headers: {
    Authorization: `Bearer ${your token}`,
  }
})

const getPokemonLocationAlola = async () => {
  
  const { data } = await graphQLFetcher(
    '/graphql/v1beta', 
    { 
      body: JSON.stringify({
        query: `
          query locationAlola($region: String) {
            region: pokemon_v2_region(where: {name: {_eq: $region}}) {
              name
            }
          }
        `,
        variables: { 
          region: 'alola'
        },
        operationName: 'locationAlola'
      })
    }
  )
  return data
}
  • response
    • No need to use response.json(), as the fetcher maps response data into:
    • status
      • The status code of the response
      • type: number
    • statusText
      • The status message corresponding to the status code
      • type: string
    • header
      • The Headers object associated with the response.
      • type: Headers
      • Use headers.get('your header key') to get the header's value
    • data
      • The API response body in JSON format
  • errors
    • If there is a request error, it will always return an error object
    • status
      • The status code of the response
      • type: number
    • statusText
      • The status message corresponding to the status code
      • type: string
    • header
      • The Headers object associated with the response.
      • type: Headers
      • Use headers.get('your header key') to get the header's value
    • message
      • If response.message can be parsed by JSON.parse, it will return the parsed object; otherwise, it returns a string
    • errors

Using with TypeScript

import { createGraphQLFetcher } from '@soie/fetcher'

type PokemonLocationAlola = {
  // ...
}

const graphQLFetcher = createGraphQLFetcher({
  timeout: 3000,
  baseURL: 'https://beta.pokeapi.co',
  headers: {
    Authorization: `Bearer ${your token}`,
  }
})

const getPokemonLocationAlola = async (): Promise<PokemonLocationAlola> => {
  
  const { data } = await graphQLFetcher<PokemonLocationAlola>(
    '/graphql/v1beta', 
    { 
      body: JSON.stringify({
        query: `
          query locationAlola($region: String) {
            region: pokemon_v2_region(where: {name: {_eq: $region}}) {
              name
            }
          }
        `,
        variables: { 
          region: 'alola'
        },
        operationName: 'locationAlola'
      })
    }
  )
  return data
}