Appearance

Connectum API Reference / @connectum/core / defineService

Function: defineService() ​

defineService<S>(descriptor, handlers, options?): ServiceDefinition

Defined in: packages/core/src/defineService.ts:74

Define a service from its descriptor and handler map.

Pass ServiceOptions to set per-service handler options, e.g. interceptors applied to every method of this service:

Type Parameters ​

S ​

S extends DescService

Parameters ​

descriptor ​

S

handlers ​

ConnectumServiceImpl<S>

options? ​

Partial<UniversalHandlerOptions>

Returns ​

ServiceDefinition

Example ​

ts
const greeter = defineService(GreeterService, {
  async sayHello(req, ctx) {
    // ctx.call(...) is available for cross-service calls
    return { message: `Hello, ${req.name}!` };
  },
}, { interceptors: [requireAuth, auditLog] });
createServer({ services: [greeter] });