Skip to content
YAGE Logo YAGE

ServiceKey

Defined in: EngineContext.ts:39

A typed key for service registration and resolution.

Keys are identified by their id string, not by object identity. A package may re-declare an id for the same service contract to avoid an optional runtime dependency; keep an owner comment beside each repeated declaration.

Type Parameters

Section titled “Type Parameters”

T

Section titled “T”

T

Constructors

Section titled “Constructors”

Constructor

Section titled “Constructor”

new ServiceKey<T>(id, options?): ServiceKey<T>

Defined in: EngineContext.ts:45

Parameters

Section titled “Parameters”
id
Section titled “id”

string

String identifier used for registration and resolution.

options?
Section titled “options?”

ServiceKeyOptions

Returns

Section titled “Returns”

ServiceKey<T>

Properties

Section titled “Properties”

_type

Section titled “_type”

readonly _type: T

Defined in: EngineContext.ts:55

Phantom field to preserve the generic type.

id

Section titled “id”

readonly id: string

Defined in: EngineContext.ts:47

String identifier used for registration and resolution.

missingHint

Section titled “missingHint”

readonly missingHint: string | undefined

Defined in: EngineContext.ts:43

Appended to the error thrown when the key resolves nowhere.

scope

Section titled “scope”

readonly scope: ServiceScope

Defined in: EngineContext.ts:41

Declared scope (engine or scene). Defaults to "engine".

Coding agents: fetch https://yage.dev/llms.txt first and prefer the Markdown references it links over these HTML pages. This page's Markdown counterpart is /llms/packages/core.md.