Skip to main content

ServiceMetadata

@webda/compiler

Type Alias: ServiceMetadata

ServiceMetadata = object

Defined in: definition.ts:385

Properties​

capabilities?​

optional capabilities?: string[]

Defined in: definition.ts:408

Capability names provided by this service, detected at compile-time.

The compiler inspects which interfaces the service class implements. If an interface has a @WebdaCapability <name> JSDoc tag, that name is added to this array. At runtime, the framework uses these to auto-discover services (e.g., registering request filters with the Router).

Example​

`["request-filter", "cors-filter"]`

commands?​

optional commands?: object

Defined in: definition.ts:423

CLI commands declared via @Command decorator on service methods.

Keys are command names (space-separated for subcommands, e.g., "aws s3"). Values describe the command handler and its arguments.

Index Signature​

[name: string]: CommandDefinition

Example​

{
  "serve": { "description": "Start server", "method": "serve", "args": { ... } },
  "aws s3": { "description": "Manage S3", "method": "s3", "args": { ... } }
}

Configuration?​

optional Configuration?: string

Defined in: definition.ts:397

Configuration for the service

Import​

Import: string

Defined in: definition.ts:389

File to import

Schema?​

optional Schema?: JSONSchema7

Defined in: definition.ts:393

Schema defining the service