Function runtimify

  • Creates ESM or UMD bundles for node modules using microbundle.

    Description
      Creates ESM or UMD bundles for node modules using `microbundle`
    
    Usage
      $ sgrud runtimify [...modules] [options]
    
    Options
      --format      Runtimify bundle format (umd or esm)  (default umd)
      --output      Output file in module root  (default runtimify.[format].js)
      --prefix      Use an alternative working directory  (default ./)
      -h, --help    Displays this message
    
    Examples
      $ sgrud runtimify # Run with default options
      $ sgrud runtimify @microsoft/fast # Runtimify `@microsoft/fast`
    

    Parameters

    • options: {
          format?: string;
          modules?: string[];
          output?: string;
          prefix?: string;
      } = {}

      The options object.

      • Optional format?: string

        runtimify bundle format (umd or esm).

        Default Value

        'umd'

      • Optional modules?: string[]

        Modules to runtimify.

        Default Value

        package.json#sgrud.runtimify

      • Optional output?: string

        Output file in module root.

        Default Value

        'runtimify.[format].js'

      • Optional prefix?: string

        Use an alternative working directory.

        Default Value

        './'

    Returns Promise<void>

    An execution Promise.

    Example

    Run with default options (not recommended):

    require('@sgrud/bin');

    sgrud.bin.runtimify();

    Example

    runtimify @microsoft/fast:

    require('@sgrud/bin');

    sgrud.bin.runtimify({
    modules: ['@microsoft/fast']
    });

Generated using TypeDoc