Skip to content

Commit 24fba78

Browse files
fix: update ssr-runtime README with new functions
1 parent f4e6b89 commit 24fba78

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

packages/lwc/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,3 +79,26 @@ import { renderComponent } from '@lwc/engine-server';
7979
## Experimental Packages
8080

8181
The `@lwc/ssr-compiler` and `@lwc/ssr-runtime` packages are still considered experimental, and may break without notice.
82+
83+
## Experimental APIs
84+
85+
### setTrustedSignalSet()
86+
87+
This experimental API enables the addition of a signal as a trusted signal. If the [ENABLE_EXPERIMENTAL_SIGNALS](https://github.com/salesforce/lwc/blob/master/packages/%40lwc/features/README.md#lwcfeatures) feature is enabled, any signal value change will trigger a re-render.
88+
89+
If `setTrustedSignalSet` is called more than once, it will throw an error. If it is never called, then no trusted signal validation will be performed. The same `setTrustedSignalSet` API must be called on both `@lwc/engine-dom` and `@lwc/signals`.
90+
91+
### setContextKeys
92+
93+
Not intended for external use. Enables another library to establish contextful relationships via the LWC component tree. The `connectContext` and `disconnectContext` symbols that are provided are later used to identify methods that facilitate the establishment and dissolution of these contextful relationships.
94+
95+
### setTrustedContextSet()
96+
97+
Not intended for external use. This experimental API enables the addition of context as trusted context. If the [ENABLE_EXPERIMENTAL_SIGNALS](https://github.com/salesforce/lwc/blob/master/packages/%40lwc/features/README.md#lwcfeatures) feature is enabled.
98+
99+
If `setTrustedContextSet` is called more than once, it will throw an error. If it is never called, then context will not be connected.
100+
101+
### ContextBinding
102+
103+
The context object's `connectContext` and `disconnectContext` methods are called with this object when contextful components are connected and disconnected. The ContextBinding exposes `provideContext` and `consumeContext`,
104+
enabling the provision/consumption of a contextful Signal of a specified variety for the associated component.

0 commit comments

Comments
 (0)