Member Junction
    Preparing search index...

    Interface PrepareServerExtensionOptions

    interface PrepareServerExtensionOptions {
        apiRootPath?: string;
        extraReservedRoots?: readonly string[];
        onInvalid?: (message: string) => void;
        onOverlap?: (message: string) => void;
        source?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    apiRootPath? extraReservedRoots? onInvalid? onOverlap? source?

    Properties

    apiRootPath?: string

    MJAPI's base path (MJAPI_BASE_PATH, e.g. /api). Every RootPath is relative to it: the returned configs carry the composed mount path (/api + /telephony/twilio). Omitted or / leaves RootPaths unchanged.

    extraReservedRoots?: readonly string[]

    Additional reserved roots from the running server (WIDGET_MOUNT_PATH, /media, …), relative to MJAPI's base path like every RootPath. Compared case-insensitively and bidirectionally (an extension at /telephony collides with a core mount at /telephony/twilio).

    onInvalid?: (message: string) => void

    Called once per skipped/invalid entry. Tests pass a spy; production logs.

    onOverlap?: (message: string) => void
    source?: string

    Label used in skip messages (package name, file path, etc.).

    Settings

    Member Visibility

    On This Page

    Properties