Options
All
  • Public
  • Public/Protected
  • All
Menu

pg-generator

Index

Namespaces

Classes

Interfaces

Type aliases

Functions

Type aliases

Context

Context: { c: Record<string, any>; o: Db | DbObject }

Context provided to render function.

Type declaration

  • c: Record<string, any>
  • o: Db | DbObject

Options

Options: GeneratorOptions & ClientOptions

Functions

generate

  • generate(generator: string, options?: Options): Promise<void>
  • generate(generator: string, subGenerator?: string, options?: Options): Promise<void>

  • Executes the default sub-generator app from a generator.

    Example

     
    generate("generator-from-npm", options);
generate(require.resolve("./local-generator"), options);

    Parameters

    • generator: string

      is the name or path of the generator. If it is a local path, use require.resolve or provide an absolute path.

    • Optional options: Options

      are the options for the generator.

    Returns Promise<void>

  • Executes a sub-generator from a generator.

    Example

     
    generate("generator-from-npm", "sub-generator");
generate(require.resolve("./local-generator"), "sub-generator", options);

    Parameters

    • generator: string

      is the name or path of the generator. If it is a local path, use require.resolve or provide an absolute path.

    • Optional subGenerator: string

      is the name of the generator.

    • Optional options: Options

      are the new options added on top of curent options.

    Returns Promise<void>

scaffold

  • scaffold(scaffoldName: string, __namedParameters: { name?: string; outDir: string }): Promise<void>

  • Creates a skeleton Node.js project for a generator (pg-generator plugin).

    throws

    error if required scaffold is unavailable or output directory contains files.

    Parameters

    • scaffoldName: string

      is the name to create scaffold from.

    • __namedParameters: { name?: string; outDir: string }
      • Optional name?: string
      • outDir: string

    Returns Promise<void>

Generated using TypeDoc