Skip to content

docs(engine-server): add deprecation notice to README @W-20496487 #5641

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
wjhsf merged 1 commit into from
Dec 12, 2025
+3 −22
Merged

docs(engine-server): add deprecation notice to README @W-20496487 #5641

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 3 additions & 22 deletions packages/@lwc/engine-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,7 @@
# @lwc/engine-server

WARNING: This is an experimental package. It is subject to change, may be removed at any time,
and should be used at your own risk!
⚠️ This package is deprecated and has been replaced by [`@lwc/ssr-compiler`](https://www.npmjs.com/package/@lwc/ssr-compiler) and [`@lwc/ssr-runtime`](https://www.npmjs.com/package/@lwc/ssr-compiler).

This package can be used to render LWC components as strings in a server environment.
## Links

## Supported APIs

This package supports the following APIs.

### renderComponent()

This function renders a string-representation of a serialized component tree, given a tag name
and an LWC constructor. The output format itself is aligned with the [current leading
proposal][explainer], but is subject to change.

```js
import { renderComponent } from '@lwc/engine-server';
import LightningHello from 'lightning/hello';

const componentProps = {};
const serialized = renderComponent('lightning-hello', LightningHello, componentProps);
```

[explainer]: https://github.com/mfreed7/declarative-shadow-dom/blob/master/README.md
- [Server-Side Rendering guide](https://lwc.dev/guide/ssr)