Description class

The self-description a service serves to its clients, and the input to client generation.

Signature:

export declare class Description 

Remarks

Declared as a class for historical reasons but never instantiated: a service returns a plain object literal, and a client receives its JSON round-trip. So do not use new Description() or instanceof Description.

A service memoizes its description after the first request for it.

Properties

Property

Modifiers

Type

Description

service

{ name: string; methods: MethodsCollectionDescription; }

The service itself: its name, and every exposed method with the inheritance chain already flattened.

types

TypesDescription

Every complex type registered in the service's process.

Read this page as plain markdown — no HTML, no navigation. For pasting into an LLM, or for an agent to fetch.