-
Notifications
You must be signed in to change notification settings - Fork 276
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Automated Build
committed
Nov 20, 2024
1 parent
b4e1e0a
commit b6f6d00
Showing
2 changed files
with
136 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,41 @@ | ||
**@sitecore-jss/sitecore-jss-angular-schematics** • **Docs** | ||
|
||
*** | ||
@sitecore-jss/sitecore-jss-angular-schematics | ||
|
||
# @sitecore-jss/sitecore-jss-angular-schematics | ||
|
||
## Table of contents | ||
|
||
### Functions | ||
|
||
- [default](README.md#default) | ||
|
||
## Functions | ||
|
||
- [default](functions/default.md) | ||
### default | ||
|
||
▸ **default**(`options`): (`host`: `Tree`) => `Promise`\<`Rule`\> | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `options` | `Schema` | | ||
|
||
#### Returns | ||
|
||
`fn` | ||
|
||
▸ (`host`): `Promise`\<`Rule`\> | ||
|
||
##### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `host` | `Tree` | | ||
|
||
##### Returns | ||
|
||
`Promise`\<`Rule`\> | ||
|
||
#### Defined in | ||
|
||
[index.ts:41](https://github.com/Sitecore/jss/blob/b4e1e0a03/packages/sitecore-jss-angular-schematics/src/jss-component/index.ts#L41) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,105 @@ | ||
**@sitecore-jss/sitecore-jss-rendering-host** • **Docs** | ||
|
||
*** | ||
@sitecore-jss/sitecore-jss-rendering-host | ||
|
||
# @sitecore-jss/sitecore-jss-rendering-host | ||
|
||
## Table of contents | ||
|
||
### Functions | ||
|
||
- [getDefaultAppInvocationInfoResolver](README.md#getdefaultappinvocationinforesolver) | ||
- [ssrMiddleware](README.md#ssrmiddleware) | ||
- [startRenderHostTunnel](README.md#startrenderhosttunnel) | ||
- [startRenderingHostServer](README.md#startrenderinghostserver) | ||
|
||
## Functions | ||
|
||
- [getDefaultAppInvocationInfoResolver](functions/getDefaultAppInvocationInfoResolver.md) | ||
- [ssrMiddleware](functions/ssrMiddleware.md) | ||
- [startRenderHostTunnel](functions/startRenderHostTunnel.md) | ||
- [startRenderingHostServer](functions/startRenderingHostServer.md) | ||
### getDefaultAppInvocationInfoResolver | ||
|
||
▸ **getDefaultAppInvocationInfoResolver**(`baseAppPath?`): `AppInvocationInfoResolver` | ||
|
||
Returns the default AppInvocationInfoResolver, which is responsible for resolving the function, within your app bundle, | ||
that should be invoked for rendering your app. | ||
|
||
By default, the resolver assumes a folder structure of: | ||
`./{baseAppPath}/{JSSAppName}/{serverBundleName}.js` | ||
|
||
`JSSAppName` is the `id` property of the JSON request body that is POSTed to the rendering host by Sitecore. | ||
|
||
`serverBundleName` is the name of the JavaScript file (typically a bundle) that contains the function for rendering your app. | ||
|
||
#### Parameters | ||
|
||
| Name | Type | Description | | ||
| :------ | :------ | :------ | | ||
| `baseAppPath?` | `Object` | The base path to your JSS app(s), defaults to `./dist` | | ||
|
||
#### Returns | ||
|
||
`AppInvocationInfoResolver` | ||
|
||
resolver | ||
|
||
#### Defined in | ||
|
||
[defaultAppInvocationInfoResolver.ts:18](https://github.com/Sitecore/jss/blob/b4e1e0a03/packages/sitecore-jss-rendering-host/src/defaultAppInvocationInfoResolver.ts#L18) | ||
|
||
___ | ||
|
||
### ssrMiddleware | ||
|
||
▸ **ssrMiddleware**(`options`): `WebServerMiddleware` | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `options` | `SSRMiddlewareOptions` | | ||
|
||
#### Returns | ||
|
||
`WebServerMiddleware` | ||
|
||
#### Defined in | ||
|
||
[ssrMiddleware.ts:41](https://github.com/Sitecore/jss/blob/b4e1e0a03/packages/sitecore-jss-rendering-host/src/ssrMiddleware.ts#L41) | ||
|
||
___ | ||
|
||
### startRenderHostTunnel | ||
|
||
▸ **startRenderHostTunnel**(`renderHostname`, `options?`): `Promise`\<`string`\> | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `renderHostname` | `string` | | ||
| `options` | `Options` | | ||
|
||
#### Returns | ||
|
||
`Promise`\<`string`\> | ||
|
||
#### Defined in | ||
|
||
[tunnel.ts:12](https://github.com/Sitecore/jss/blob/b4e1e0a03/packages/sitecore-jss-rendering-host/src/tunnel.ts#L12) | ||
|
||
___ | ||
|
||
### startRenderingHostServer | ||
|
||
▸ **startRenderingHostServer**(`config`): `void` | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `config` | `RenderingHostServerOptions` | | ||
|
||
#### Returns | ||
|
||
`void` | ||
|
||
#### Defined in | ||
|
||
[renderingHostServer.ts:47](https://github.com/Sitecore/jss/blob/b4e1e0a03/packages/sitecore-jss-rendering-host/src/renderingHostServer.ts#L47) |