Function postbuild

  • postbuild(options?): Promise<void>

  • Replicates exported package metadata for SGRUD-based projects.

    Description
  Replicates exported package metadata for SGRUD-based projects

Usage
  $ sgrud postbuild [...modules] [options]

Options
  --prefix      Use an alternative working directory  (default ./)
  -h, --help    Displays this message

Examples
  $ sgrud postbuild # Run with default options
  $ sgrud postbuild ./project/module # Postbuild ./project/module
  $ sgrud postbuild --prefix ./module # Run in ./module

    Parameters

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

      The options object.

      • Optional modules?: string[]

        Modules to postbuild.

        Default Value

        package.json#sgrud.postbuild

      • Optional prefix?: string

        Use an alternative working directory.

        Default Value

        './'

    Returns Promise<void>

    An execution Promise.

    Example

    Run with default options:

    require('@sgrud/bin');

    sgrud.bin.postbuild();

    Example

    postbuild ./project/module:

    require('@sgrud/bin');

    sgrud.bin.postbuild({
      modules: ['./project/module']
    });

    Example

    Run in ./module:

    require('@sgrud/bin');

    sgrud.bin.postbuild({
      prefix: './module'
    });

Settings

Member Visibility

Theme

Generated using TypeDoc