Libraries
    Preparing search index...

    Interface AsyncApiServerEntry

    A server entry in the AsyncAPI 3.0 servers map. Describes a connection endpoint where the API is accessible.

    https://www.asyncapi.com/docs/reference/specification/v3.0.0#serverObject

    interface AsyncApiServerEntry {
        description?: string;
        host: string;
        pathname?: string;
        protocol: "http" | "ws" | "wss" | "https";
    }
    Index

    Properties

    description? host pathname? protocol

    Properties

    description?: string

    An optional string describing the server.

    host: string

    The host of the server (hostname + optional port).

    `'api.example.com'`, `'localhost:3000'`
    pathname?: string

    The path component of the server URL.

    protocol: "http" | "ws" | "wss" | "https"

    The protocol used to connect to the server.

    Settings

    Member Visibility

    On This Page

    Properties