Class StubsManager

Stub Manager is used to read and copy stubs from different sources. Also allows creating resources from pre-existing stubs

Index

Constructors

Methods

Constructors

constructor

new StubsManager(app: Application<any>, publishTarget: string): StubsManager
Creates a new StubsManager instance
Parameters
- app: Application<any>
  The application instance
- publishTarget: string
  Directory path where stubs should be published
Returns StubsManager
- Defined in src/stubs/manager.ts:42

Methods

build

build(
stubName: string,
options?: { source?: string; pkg?: string },
): Promise<Stub>
Creates an instance of stub by its name. The lookup is performed inside the publishTarget and the optional source or pkg destination.
Parameters
- stubName: string
  Name of the stub file to build
- Optionaloptions: { source?: string; pkg?: string }
  Optional configuration for stub source
Returns Promise<Stub>
Promise that resolves to a Stub instance
- Defined in src/stubs/manager.ts:72

copy

copy(
stubPath: string,
options: { overwrite?: boolean } & ({ source: string } | { pkg: string }),
): Promise<string[]>
Copy one or more stub files from a custom location to publish target.
Parameters
- stubPath: string
  Path to the stub file or directory to copy
- options: { overwrite?: boolean } & ({ source: string } | { pkg: string })
  Copy options including source/package and overwrite settings
Returns Promise<string[]>
Promise that resolves to an array of copied file paths
- Defined in src/stubs/manager.ts:113