Back to Encore

encore.dev/service

docs/ts/runtime/service.mdx

1.57.51.2 KB
Original Source

Classes

<!-- symbol-start: Service -->

Service <SymbolSource href="https://github.com/encoredev/encore/blob/main/runtimes/js/encore.dev/service/mod.ts#L12" />

Defines an Encore backend service.

Use this class to define a new backend service with the given name. The scope of the service is its containing directory, and all subdirectories.

It must be called from files named encore.service.ts, to enable Encore to efficiently identify possible service definitions.

Constructors

Constructor <SymbolSource href="https://github.com/encoredev/encore/blob/main/runtimes/js/encore.dev/service/mod.ts#L16" />

new Service(name, cfg?): Service

Parameters
name

string

cfg?

ServiceConfig

Returns

Service

Properties

cfg

readonly cfg: ServiceConfig

name

readonly name: string

<!-- symbol-end -->

Interfaces

<!-- symbol-start: ServiceConfig -->

ServiceConfig <SymbolSource href="https://github.com/encoredev/encore/blob/main/runtimes/js/encore.dev/service/mod.ts#L22" />

Properties

middlewares?

optional middlewares?: Middleware[]

<!-- symbol-end -->