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

stable-ts-type

v1.0.5

Published

Obtain the most stable type code of 'typescript' through multiple network requests

Downloads

38

Readme

stable-ts-type

根据多次api请求或者json的example,自动生成ts类型代码

TODO

  • 支持将基础模板内带的注释补进最终生成的代码(可能要改动quicktype源码)

install

npm i stable-ts-type

use1: Generator

import fs from 'fs';
import path from 'path';
import { Generator } from 'stable-ts-type';
import type { Input } from 'stable-ts-type';

const inputs: Input[] = [
  {
    type: 'request',
    value: `curl 'https://www.npmjs.com/search?q=test&page=1&perPage=20' \
  -H 'x-spiferack: 1' \
  --compressed`,
    mock: {
      params: {
        q: 'test',
        'page|+1': 10000,
        perPage: 10,
      },
    },
    mockCount: 5,
  },
  {
    type: 'request',
    value: {
      url: 'https://www.npmjs.com/search?q=test',
      headers: {
        'x-spiferack': 1,
      },
      method: 'GET',
    },
    mock: {
      params: {
        q: 'test',
        'page|+1': 0,
        perPage: 10,
      },
    },
    mockCount: 5,
  },
  {
    type: 'example-json',
    value: {
      test: true,
    },
  },
  {
    type: 'example-json',
    value: `
      {
        test: /** xxx */ 'hhh', // hhh
      }
    `,
  },
];

const generator = new Generator(inputs, {
  on(event, codeOrError) {
    switch (event) {
      case 'CHUNK_DONE':
        console.log('-----CHUNK_DONE');
        fs.writeFileSync(path.resolve(__dirname, './build.ts'), codeOrError as string);
        break;
      case 'DONE':
        console.log('-----done');
        break;
      case 'ERROR':
        console.log('-----error');
        // console.log('-----error', codeOrError);
        break;
    }
  },
  // ms
  requestInterval: 500,
  // https://www.npmjs.com/package/quicktype
  quickTypeOpts: {
    rendererOptions: {
      'just-types': 'true', // 只生成类型
      'nice-property-names': 'false', // 更人性的属性名, 比如postId -> postID
      'explicit-unions': 'false', // 是否要把 unions 抽出来成为一个单独的类型
      'prefer-unions': 'false', // 使用 unions 或 enum
      'prefer-types': 'false', // 使用 types 或 interface
    },
    allPropertiesOptional: true, // 属性是否为可选
    indentation: '  ', // 缩进
    interMenu: true, // interMenu为true时, 列表中, 出现少量字符串会自动生成枚举, 多数才为string
  },
});

generator.generate();

output:

export interface Response {
  test?:              boolean | string;
  formData?:          FormData;
  objects?:           Object[];
  total?:             number;
  time?:              string;
  pagination?:        Pagination;
  url?:               string;
  user?:              null;
  auditLogEnabled?:   boolean;
  userEmailVerified?: null;
  csrftoken?:         string;
  notifications?:     any[];
  npmExpansions?:     string[];
}

export interface FormData {
  search?: Search;
}

export interface Search {
  q?:       PerPage;
  page?:    Page;
  perPage?: PerPage;
// ...
// ...

use2: simpleGenerate

import { simpleGenerate } from 'stable-ts-type';
import type { Input } from 'stable-ts-type';

const inputs: Input[] = [{
  type: 'example-json',
  value: `
    {
      test: /** xxx */ 'hhh', // hhh
    }
  `,
}];

simpleGenerate(inputs, { requestInterval: 500 })
  .then(code => console.log(code))
  .catch(error => console.log(error));