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

openapi-typescript-client-interface

v0.1.0-4

Published

1. Download json file from OpenApi url and convert to TS ```shell npx openapi-typescript http://localhost:8000/openapi.json --output src/apiDefinition.ts ``` 2. Replace interfaces with types (I am not sure why types work better than interfaces) ```shel

Downloads

5

Readme

Generate api definitions

  1. Download json file from OpenApi url and convert to TS
npx openapi-typescript http://localhost:8000/openapi.json --output src/apiDefinition.ts
  1. Replace interfaces with types (I am not sure why types work better than interfaces)
sed -Ei '' "s/export interface ([a-zA-Z]*)/export type \1 =/" src/apiDefinition.ts

Usage

import type { AxiosResponse } from 'axios';
import { ApiInterfaceGenerator } from 'openapi-typescript-client-interface';

// import type 'paths' from file generated using openapi-typescript
import { paths } from './apiDefinition';

// let the library compute interface by paths
type ApiInterface = ApiInterfaceGenerator<paths>

// implement the interface (this could also be done using es6 Proxy dynamicaly however Proxy is not correctly typed in TS yet)
const api: ApiInterface = {
  '/': {
    get: (): Promise<AxiosResponse<{ pageTitle: string }>> => {
      return axios.get('/')
    },
  },
}

// TS can determine available methods under each route, parameters, body and even response type
// only reject type can't be infered because TS can't handle it right now https://stackoverflow.com/a/50071254/3265676
api['/'].get().then(({ pageTitle }) => {
  console.log(pageTitle);
})

Method and parameter support:

GET

  • [x] path parameters
  • [x] query parameters

POST

  • [x] path parameters
  • [x] query parameters
  • [x] request body

PUT

  • [ ] method itself
  • [ ] path parameters
  • [ ] query parameters
  • [ ] request body

PATCH

  • [ ] method itself
  • [ ] path parameters
  • [ ] query parameters
  • [ ] request body

DELETE

  • [ ] method itself
  • [ ] path parameters
  • [ ] query parameters