Skip to content

chore: update readme #176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Brooooooklyn merged 2 commits into from
Mar 27, 2026
Merged

chore: update readme #176

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad19be8
chore: update readme
eryue0220 Mar 27, 2026
1c239d5
ci
eryue0220 Mar 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ export default defineConfig({
plugins: [
angular({
// Optional configuration
angularVersion: 21,
enableHmr: true,
angularVersion: { major: 21, minor: 0, patch: 0 },
liveReload: true,
}),
],
})
Expand All @@ -57,8 +57,8 @@ const result = await compileTemplate(
'AppComponent',
'app.component.ts',
{
angularVersion: 21,
enableHmr: false,
angularVersion: { major: 21, minor: 0, patch: 0 },
hmr: false,
},
)

Expand Down Expand Up @@ -115,10 +115,14 @@ Returns: `Promise<TransformResult>`
```typescript
interface TransformOptions {
// Angular version (19, 20, 21)
angularVersion?: number
angularVersion?: {
major: number
minor: number
patch: number
}

// Enable Hot Module Replacement
enableHmr?: boolean
hmr?: boolean

// Enable cross-file type elision
enableCrossFileElision?: boolean
Expand Down
Loading