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

@squonk/data-manager-client

v3.1.0

Published

TypeScript client for the Squonk Data Manager API. Generated from the Open API spec with orval. Provides React Hooks to fetch data with react-query using Axios under-the-hood.

Downloads

1,307

Readme

Data Manager API JS Client

npm version

This repo is a NodeJS package that generates a typescript client from an open api specification.

  • Consumes the Squonk Data Manager API
  • Generated from the latest OpenAPI tag with Orval
  • Typescript
  • Calls made by Axios (this might change)
  • Functions to call each API path
  • React-Query hooks for use in React applications

Output

Provides typescript async functions and react hooks. The contents published packages depend on the version of the openapi.yaml used to generate it. In general though, the package is organised as follows:

All types can be imported from the main entry point:

import type { Task, JobDetail, ... } from '@squonk/data-manager-client';

The custom instance (what is used to make all Axios calls) can also be imported from here:

import { customInstance } from '@squonk/data-manager-client';

Each tag from the openapi.yaml is used to create a sub-entry point. For example, the functions to make requests and the react-query hooks for a dataset tag can be imported as follows:

import { useGetDatasets, useCreateDataset, createDataset, ... } from '@squonk/data-manager-client/dataset';