Interface WsApi<RequestCommandsT, ResponseCommandsT, QueryT>

A generic WebSocket API description

interface WsApi<RequestCommandsT, ResponseCommandsT, QueryT> {
    deprecated?: string | boolean;
    description?: string;
    example?: string;
    isYaschemaApi: true;
    isYaschemaWsApi: true;
    name: string;
    routeType: string;
    schemas: {
        connection?: {
            query?: Schema<QueryT>;
        };
        requests: RequestCommandsT;
        responses: ResponseCommandsT;
    };
    url: string;
}

Type Parameters

Hierarchy

  • Api
    • WsApi

Properties

deprecated? description? example? isYaschemaApi isYaschemaWsApi name routeType schemas url

Properties

Optionaldeprecated

deprecated?: string | boolean

If true or a string, use of this Api is deprecated and usage should be discontinued as soon as possible. A string value may be used to document why the deprecation occurred and/or preferred upgrade strategies and APIs.

Optionaldescription

description?: string

A description, which can be used by code generation tools to generate documentation

Optionalexample

example?: string

An example, which can be used by code generation tools to generate documentation

isYaschemaApi

isYaschemaApi

isYaschemaWsApi

isYaschemaWsApi

name

name: string

A name that can be used to describe this API, when logging for example

routeType

routeType: string

The type of route, which will be used to select a URL base and is configurable using setUrlBaseForRouteType

schemas

schemas: {
    connection?: {
        query?: Schema<QueryT>;
    };
    requests: RequestCommandsT;
    responses: ResponseCommandsT;
}

url

url: string

The URL for accessing this API, which may be relative to a URL base configuring for the routeType. Use {…} syntax to mark parameters, as you might with Express.

Settings

Member Visibility

On This Page

Properties