Giter Club home page Giter Club logo

typescript-polyfills-generator's Introduction

typescript-polyfills-generator

Build Status npm npm npm Coverage Status

Runtime polyfills generator for TypeScript projects, inspired by @babel/preset-env

โš ๏ธ !!! This module is on Proof of Concept stage, please, be careful using it in production !!!

TLDR

This module solves microsoft/TypeScript#20095

Problem

If you do not use Babel in your development process (as I do), but you still want to have a flexible way to include polyfills based on browserslist config (as @babel/preset-env does) this module comes to rescue.

Usage

Requirements

  • Node.js v10.3.0+

Installation

npm i --save-dev typescript-polyfills-generator

Webpack integration

1. Create a transformers file

// webpack.ts-transformers.js
const {createPolyfillsTransformerFactory} = require('typescript-polyfills-generator');
const getCustomTransformers = () => {
  return {
      before: [
          createPolyfillsTransformerFactory({
              targets: 'last 2 version, not ie < 11, not ie_mob < 11, safari >= 9'
          })
      ]
  };
};

module.exports = getCustomTransformers;
Options:

- targets - optional, you may use any valid Browserslist config

- polyfills - optional, you may specify a custom list of polyfills:

createPolyfillsTransformerFactory({
    polyfills: {
        'es6.fetch': 'my-polyfills-module', // import from 'my-polyfills-module'; will be added if Fetch API is not supported by your targets
        'es6.object.assign': false // never include polyfill for Object.assign
    }
})

2. Specify a path to transformers file in TS loader

const path = require('path');

// Your webpack config...
{
    test: /\.tsx?$/,
    use: [
        {
            loader: 'ts-loader', // or 'awesome-typescript-loader'
            options: {
                getCustomTransformers: path.join(__dirname, './webpack.ts-transformers.js')
            }
        }
    ]
}

Examples

In

// test1.ts
const map = new Map();
// test2.ts
const fetchPromise = fetch('../data.json');

Out (if environment doesn't support it)

// test1.ts
import "core-js/modules/es6.map";
const map = new Map();
// test2.ts
import "whatwg-fetch";
const fetchPromise = fetch('../data.json');

Check awesome-typescript-loader and ts-loader test cases to find more examples.

Polyfills

All polyfills are imported from core-js package, but there are some specific polyfills that are not supported by core-js:

Check the transfromer options to see how disable or reassign any polyfill module.

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

This module would not be possible if not for a number of awesome open-source projects, like

typescript-polyfills-generator's People

Contributors

webschik avatar

Watchers

James Cloos avatar  avatar

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.