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

@soluzioni-futura/openapi2ts

v1.5.0

Published

openapi2ts is a Node.js module that generates TypeScript interfaces from an OpenAPIv3 schema. It exports a `parse` function that takes an `Options` object as input and generates a `.ts` file containing TypeScript interfaces. The module also includes a CLI

Downloads

210

Readme

openapi2ts

openapi2ts is a Node.js module that generates TypeScript interfaces from an OpenAPIv3 schema. It exports a parse function that takes an Options object as input and generates a .ts file containing TypeScript interfaces. The module also includes a CLI interface for parsing OpenAPI schema files and generating TypeScript interface files.

Installation

To install openapi2ts, you need to have Node.js and npm installed on your machine. Then, run the following command:

npm i @soluzioni-futura/openapi2ts

Usage

Module interface

The module exports a single function parse which generates a TypeScript file from an OpenAPIv3 schema. The parse function takes an Options object as input and returns a Promise that resolves to an object containing at key data the generated TypeScript file as a string and at key exports a set of all exported type names. Here's an example of how to use the parse function:

import { parse, Options } from "openapi2ts";

const options: Options = {
  openapi: "path/to/openapi.json",
  outputFilePath: "path/to/output.ts",
  bannerComment: `/* My Banner Comment */`
};

parse(options)
  .then((data: string) => {
    console.log(data);
  })
  .catch((err: any) => {
    console.error(err);
  });

The Options object has the following properties:

  • openapi: the path to the OpenAPIv3 schema file or the schema object itself. This property is required.
  • outputFilePath: the path to the output TypeScript file. If this property is not provided, the generated TypeScript file will not be saved to disk.
  • bannerComment: a banner comment that is added at the top of the generated TypeScript file. If this property is not provided, a default banner comment will be used.

CLI Interface

The module also includes a CLI interface that can be used to parse an OpenAPI schema file and generate a TypeScript interface file. Here's an example of how to use the CLI:

openapi2ts path/to/openapi.json path/to/output.ts

License

This module is released under the MIT License.