docs(platform-server): add doc string for PlatformOptions

This commit is contained in:
Vikram Subramanian 2017-07-17 14:22:54 -07:00 committed by Alex Rickabaugh
parent b399cb26d9
commit e03adb9edd
1 changed files with 17 additions and 0 deletions

View File

@ -18,9 +18,26 @@ import {INITIAL_CONFIG} from './tokens';
const parse5 = require('parse5'); const parse5 = require('parse5');
/**
* Options used to configure the server Platform instance that is created in {@link renderModule}
* and {@link renderModuleFactory}.
*
* @experimental
*/
export interface PlatformOptions { export interface PlatformOptions {
/**
* The full document HTML of the page to render as a string.
*/
document?: string; document?: string;
/**
* The URL for the current render request.
*/
url?: string; url?: string;
/**
* Platform level providers for the current render request.
*/
extraProviders?: Provider[]; extraProviders?: Provider[];
} }