Arize Phoenix TS
    Preparing search index...

    Function ensureServerCapability

    • Check the Phoenix server version before allowing a capability to proceed.

      Throws if the connected Phoenix server is older than the minimum version required by the given capability. Also throws if the server version cannot be determined — this typically means the server is too old to report its version at all and is therefore incompatible with this client.

      Parameters

      • __namedParameters: {
            client: {
                config: ClientOptions;
                DELETE: ClientMethod<paths, "delete", `${string}/${string}`>;
                GET: ClientMethod<paths, "get", `${string}/${string}`>;
                getServerVersion: () => Promise<SemanticVersion>;
                HEAD: ClientMethod<paths, "head", `${string}/${string}`>;
                OPTIONS: ClientMethod<paths, "options", `${string}/${string}`>;
                PATCH: ClientMethod<paths, "patch", `${string}/${string}`>;
                POST: ClientMethod<paths, "post", `${string}/${string}`>;
                PUT: ClientMethod<paths, "put", `${string}/${string}`>;
                TRACE: ClientMethod<paths, "trace", `${string}/${string}`>;
                eject(...middleware: Middleware[]): void;
                use(...middleware: Middleware[]): void;
            };
            requirement: CapabilityRequirement;
        }

      Returns Promise<void>

      import { ensureServerCapability } from "../utils/serverVersionUtils";
      import { GET_SESSION } from "../constants/serverRequirements";

      await ensureServerCapability({ client, requirement: GET_SESSION });

    Settings

    Member Visibility