60 lines
1.8 KiB
TypeScript
60 lines
1.8 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright Google LLC All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
|
|
import {InjectionToken} from '@angular/core';
|
|
|
|
/**
|
|
* Config object passed to initialize the platform.
|
|
*
|
|
* @publicApi
|
|
*/
|
|
export interface PlatformConfig {
|
|
/**
|
|
* The initial DOM to use to bootstrap the server application.
|
|
* @default create a new DOM using Domino
|
|
*/
|
|
document?: string;
|
|
/**
|
|
* The URL for the current application state. This is used for initializing
|
|
* the platform's location. `protocol`, `hostname`, and `port` will be
|
|
* overridden if `baseUrl` is set.
|
|
* @default none
|
|
*/
|
|
url?: string;
|
|
/**
|
|
* Whether to append the absolute URL to any relative HTTP requests. If set to
|
|
* true, this logic executes prior to any HTTP interceptors that may run later
|
|
* on in the request. `baseUrl` must be supplied if this flag is enabled.
|
|
* @default false
|
|
*/
|
|
useAbsoluteUrl?: boolean;
|
|
/**
|
|
* The base URL for resolving absolute URL for HTTP requests. It must be set
|
|
* if `useAbsoluteUrl` is true, and must consist of protocol, hostname,
|
|
* and optional port. This option has no effect if `useAbsoluteUrl` is not
|
|
* enabled.
|
|
*/
|
|
baseUrl?: string;
|
|
}
|
|
|
|
/**
|
|
* The DI token for setting the initial config for the platform.
|
|
*
|
|
* @publicApi
|
|
*/
|
|
export const INITIAL_CONFIG = new InjectionToken<PlatformConfig>('Server.INITIAL_CONFIG');
|
|
|
|
/**
|
|
* A function that will be executed when calling `renderModuleFactory` or `renderModule` just
|
|
* before current platform state is rendered to string.
|
|
*
|
|
* @publicApi
|
|
*/
|
|
export const BEFORE_APP_SERIALIZED =
|
|
new InjectionToken<Array<() => void | Promise<void>>>('Server.RENDER_MODULE_HOOK');
|