API Reference
createConfig
import { createConfig } from '@ng-rspack/build';
The createConfig function is used to create an Rspack
configuration object setup for Angular applications.
It takes an optional Configuration object as an argument, which
allows for customization of the Rspack configuration.
function createConfig(
options: Partial<AngularRspackPluginOptions>,
rspackConfigOverrides?: Partial<Configuration>
)
Examples
The following example shows how to create a configuration for a SSR application:
rspack.config.ts
import { createConfig } from '@ng-rspack/build';
export default createConfig({
browser: './src/main.ts',
server: './src/main.server.ts',
ssrEntry: './src/server.ts',
});
AngularRspackPluginOptions
The AngularRspackPluginOptions object is an object that contains the
following properties:
export interface AngularRspackPluginOptions {
root: string;
index: string;
browser: string;
server?: string;
ssrEntry?: string;
polyfills: string[];
assets: string[];
styles: string[];
scripts: string[];
fileReplacements: FileReplacement[];
jit: boolean;
inlineStylesExtension: InlineStyleExtension;
tsconfigPath: string;
hasServer: boolean;
skipTypeChecking: boolean;
useTsProjectReferences?: boolean;
}
root
string
The root directory of the project. This is the directory where the rsbuild.config.ts file is located.
index
string
The path to the index.html file. This is used to determine the base html template to use.
browser
string
The path to the browser entry file. This is used to determine the entry point for the browser build. It is usually ./src/main.ts
server
string
The path to the server entry file. This is used to determine the entry point for the server build. It is usually ./src/main.server.ts
ssrEntry
string
The path to the node server entry file. This contains the express server setup. It is usually ./src/server.ts
polyfills
Array<string>
An array of polyfills to include in the build. Can be either a path to a polyfill file or a package name.
assets
Array<string>
An array of assets to include in the build. Can be a path to a directory or a file. Resolved from the path provided in root.
styles
Array<string>
An array of styles to include in the build. Resolved from the path provided in root.
scripts
Array<string>
An array of scripts to include in the build. Resolved from the path provided in root.
fileReplacements
Array<FileReplacement>
An array of file replacements to be used in the build. This is used to replace files during the build process.
jit
boolean
Default: false
A boolean value indicating whether to use the JIT mode. This is used to tell the Angular compiler to use Just-In-Time Compilation. **Not Recommended**
inlineStylesExtension
'css' | 'scss' | 'sass'
The inline styles extension to use. This is used to inform the compiler how to handle inline styles, setting up Sass compilation if required.
tsconfigPath
string
Default: ./tsconfig.app.json
The path to the TypeScript configuration file. This is used to set compilerOptions for the Angular compilation.
hasServer
boolean
internal
A boolean value indicating whether the project has a server. This is inferred based on the presence of ssrEntry and server and does not need to be set manually.
skipTypeChecking
boolean
Default: false
A boolean value indicating whether to skip type checking. This is used to skip the type checking process during the build process.
useTsProjectReferences
boolean
Default: false
A boolean value indicating whether to use TypeScript project references.