Skip to content

Commit 70e51c4

Browse files
authored
docs(engine-server): add deprecation notice to README (#5641)
1 parent 6bf6312 commit 70e51c4

File tree

1 file changed

+3
-22
lines changed

1 file changed

+3
-22
lines changed
Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,7 @@
11
# @lwc/engine-server
22

3-
WARNING: This is an experimental package. It is subject to change, may be removed at any time,
4-
and should be used at your own risk!
3+
⚠️ 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).
54

6-
This package can be used to render LWC components as strings in a server environment.
5+
## Links
76

8-
## Supported APIs
9-
10-
This package supports the following APIs.
11-
12-
### renderComponent()
13-
14-
This function renders a string-representation of a serialized component tree, given a tag name
15-
and an LWC constructor. The output format itself is aligned with the [current leading
16-
proposal][explainer], but is subject to change.
17-
18-
```js
19-
import { renderComponent } from '@lwc/engine-server';
20-
import LightningHello from 'lightning/hello';
21-
22-
const componentProps = {};
23-
const serialized = renderComponent('lightning-hello', LightningHello, componentProps);
24-
```
25-
26-
[explainer]: https://github.com/mfreed7/declarative-shadow-dom/blob/master/README.md
7+
- [Server-Side Rendering guide](https://lwc.dev/guide/ssr)

0 commit comments

Comments
 (0)