Stone.js API
    Preparing search index...

    Interface NodeHttpOptions

    Interface for configuring the NodeHttp decorator.

    This interface extends NodeHttpAdapterConfig and allows partial customization of the Node.js HTTP adapter blueprint configuration.

    interface NodeHttpOptions {
        alias?: string;
        current?: boolean;
        default?: boolean;
        errorHandlers?: Record<
            string,
            MetaAdapterErrorHandler<
                RawEventType,
                RawResponseType,
                ExecutionContextType,
            >,
        >;
        eventHandlerResolver?: AdapterEventHandlerResolver<
            IncomingHttpEvent,
            OutgoingHttpResponse,
        >;
        isSsl?: boolean;
        middleware?: AdapterMixedPipeType<
            AdapterContext<
                IncomingMessage,
                ServerResponse<IncomingMessage>,
                NodeHttpServer,
                IncomingHttpEvent,
                IncomingHttpEventOptions,
                OutgoingHttpResponse,
            >,
            ServerResponse<IncomingMessage>,
        >[];
        platform?: string;
        printUrls?: boolean;
        resolver?: AdapterResolver;
        server?: NodeServerOptions;
        serverMiddleware?: ServerMiddleware[];
        shutdownGracePeriod?: number;
        url?: string;
        variant?: AdapterVariant;
    }

    Hierarchy

    Index
    alias? current? default? errorHandlers? eventHandlerResolver? isSsl? middleware? platform? printUrls? resolver? server? serverMiddleware? shutdownGracePeriod? url? variant?
    alias?: string

    The alias name for the adapter. This is a unique identifier used to reference the adapter. Optional property.

    current?: boolean

    The current status identifier for the adapter. Used to indicate if this adapter instance is active or currently in use. Optional property.

    default?: boolean

    Defines whether this adapter is the default adapter used by the application. Optional property.

    errorHandlers?: Record<
        string,
        MetaAdapterErrorHandler<
            RawEventType,
            RawResponseType,
            ExecutionContextType,
        >,
    >

    Error handlers used to manage and report errors that occur within the adapter. These handlers can be used to customize error handling behavior and logging.

    eventHandlerResolver?: AdapterEventHandlerResolver<
        IncomingHttpEvent,
        OutgoingHttpResponse,
    >

    The event handler resolver used to create instances of the event handler.

    isSsl?: boolean

    Determines if the server should use SSL.

    middleware?: AdapterMixedPipeType<
        AdapterContext<
            IncomingMessage,
            ServerResponse<IncomingMessage>,
            NodeHttpServer,
            IncomingHttpEvent,
            IncomingHttpEventOptions,
            OutgoingHttpResponse,
        >,
        ServerResponse<IncomingMessage>,
    >[]

    The middleware used for processing incoming or outgoing data in the adapter. Middleware can modify or handle events at different stages of the adapter's lifecycle.

    platform?: string

    The platform identifier for the adapter. This is used to categorize the adapter based on the environment or technology it supports.

    printUrls?: boolean

    Determines if the server should print the URL when starting.

    resolver?: AdapterResolver

    The class type resolver used to create instances of the adapter.

    server?: NodeServerOptions

    Additional server configurations for the Node HTTP server.

    serverMiddleware?: ServerMiddleware[]

    The platform middleware used for processing platform node HTTP requests and responses. This middleware is executed before the adapter middleware. This middleware is lower-level and should be used for platform-specific processing. You can connect or express like middleware here to process request just before the Stone adapter middleware.

    shutdownGracePeriod?: number

    How long, in milliseconds, requests in flight are given to finish after SIGINT/SIGTERM before the process exits anyway. Zero-config: it defaults to 10 seconds, which is under the grace period every common orchestrator gives a container.

    url?: string

    The base URL used by the node http to run the application.

    variant?: AdapterVariant

    The category of platform this adapter integrates, for grouping and reporting.

    Open by design: the core cannot hold the list of platforms that will ever exist, and a closed union would mean every new one needs a core release before it can name itself. The known categories are listed for completion; nothing in the framework branches on this value, which is what makes widening it safe. Match on platform instead when you need to identify a specific integration.

    Settings
    Member Visibility

    On This Page
    Properties