Stone.js API
    Preparing search index...

    Adapter configuration for the Fetch adapter.

    interface FetchAdapterAdapterConfig {
        alias?: string;
        current?: boolean;
        default?: boolean;
        errorHandlers: Record<
            string,
            MetaAdapterErrorHandler<
                RawEventType,
                RawResponseType,
                ExecutionContextType,
            >,
        >;
        eventHandlerResolver: AdapterEventHandlerResolver<
            IncomingHttpEvent,
            OutgoingHttpResponse,
        >;
        middleware: AdapterMixedPipeType<
            AdapterContext<
                Request,
                Response,
                FetchExecutionContext,
                IncomingHttpEvent,
                IncomingHttpEventOptions,
                OutgoingHttpResponse,
            >,
            Response,
        >[];
        platform: string;
        resolver: AdapterResolver;
        variant: AdapterVariant;
    }

    Hierarchy

    • AdapterConfig<
          Request,
          Response,
          FetchExecutionContext,
          IncomingHttpEvent,
          IncomingHttpEventOptions,
          OutgoingHttpResponse,
      >
      • FetchAdapterAdapterConfig
    Index
    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.

    middleware: AdapterMixedPipeType<
        AdapterContext<
            Request,
            Response,
            FetchExecutionContext,
            IncomingHttpEvent,
            IncomingHttpEventOptions,
            OutgoingHttpResponse,
        >,
        Response,
    >[]

    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.

    resolver: AdapterResolver

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

    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.