index.api.md

API Report File for "@angular/ssr_node"

Do not edit this file. It is a report generated by API Extractor.

import { ApplicationRef } from '@angular/core';
import { BootstrapContext } from '@angular/platform-browser';
import { Http2ServerRequest } from 'node:http2';
import { Http2ServerResponse } from 'node:http2';
import { IncomingMessage } from 'node:http';
import { ServerResponse } from 'node:http';
import { StaticProvider } from '@angular/core';
import { Type } from '@angular/core';

// @public
export class AngularNodeAppEngine {
    constructor();
    handle(request: IncomingMessage | Http2ServerRequest, requestContext?: unknown): Promise<Response | null>;
}

// @public
export class CommonEngine {
    constructor(options: CommonEngineOptions);
    render(opts: CommonEngineRenderOptions): Promise<string>;
}

// @public (undocumented)
export interface CommonEngineOptions {
    allowedHosts: readonly string[];
    bootstrap?: Type<{}> | ((context: BootstrapContext) => Promise<ApplicationRef>);
    enablePerformanceProfiler?: boolean;
    providers?: StaticProvider[];
}

// @public (undocumented)
export interface CommonEngineRenderOptions {
    bootstrap?: Type<{}> | ((context: BootstrapContext) => Promise<ApplicationRef>);
    // (undocumented)
    document?: string;
    // (undocumented)
    documentFilePath?: string;
    inlineCriticalCss?: boolean;
    providers?: StaticProvider[];
    publicPath?: string;
    // (undocumented)
    url?: string;
}

// @public
export function createNodeRequestHandler<T extends NodeRequestHandlerFunction>(handler: T): T;

// @public
export function createWebRequestFromNodeRequest(nodeRequest: IncomingMessage | Http2ServerRequest): Request;

// @public
export function isMainModule(url: string): boolean;

// @public
export type NodeRequestHandlerFunction = (req: IncomingMessage, res: ServerResponse, next: (err?: unknown) => void) => Promise<void> | void;

// @public
export function writeResponseToNodeResponse(source: Response, destination: ServerResponse | Http2ServerResponse): Promise<void>;

// (No @packageDocumentation comment for this package)