Giter Site home page Giter Site logo

json-resume-types's Introduction

Json-Resume-Types

Generates Typescript types from the current version of resume-schema. This will be updated whenever resume-schema is updated by using Dependabot to trigger the push workflow. New versions will always match resume-schema's version.

Installation

npm install @supastuff/json-resume-types --save

Usage

It's really only 1 type, but you can use "Lookup types" to get the types of sub properties:

import {ResumeSchema} from '@supastuff/json-resume-types'

function doStuff(work: ResumeSchema["work"]): void { ... }

Limitations

The types are generated by json2ts so some of it's issues came along for the ride:

  • Iso8601 doesn't keep it's regex pattern. You'll just have to trust that where ever you use Iso8601, it has the correct format
  • additionalProperties are defined as [k: string]: unknown. The unknown type may or may not cause problems for you. I think it's fine, but it sounds like there are complaints about it... issue#356, issue#335

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.