mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-23 00:13:13 +09:00
Attach hooks in fromContext and export it as the entrypoint
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
d3e9803069
commit
b4cbba1e9a
1 file changed
+5
-6
@@ -130,8 +130,8 @@ The context types are `ControllerPluginContext`, `HostPluginContext`, `InstanceP
|
|||||||
|
|
||||||
### Keeping a class for state
|
### Keeping a class for state
|
||||||
|
|
||||||
If the plugin has enough state that a class is still the better fit, give the class a private constructor and an async `static fromContext` that creates it from the context.
|
If the plugin has enough state that a class is still the better fit, give the class a private constructor and an async `static fromContext` that creates it from the context and attaches its hooks.
|
||||||
The entrypoint calls `fromContext` and attaches the hooks to methods on the returned object.
|
`fromContext` can then be the default export of the entrypoint.
|
||||||
Instances are kept in a static `WeakMap` keyed by the controller, host or instance they belong to, which lets other code look them up without holding a reference to them.
|
Instances are kept in a static `WeakMap` keyed by the controller, host or instance they belong to, which lets other code look them up without holding a reference to them.
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
@@ -150,6 +150,7 @@ export class Frobber {
|
|||||||
static async fromContext(context: ControllerPluginContext) {
|
static async fromContext(context: ControllerPluginContext) {
|
||||||
const frobber = new Frobber(context.controller, context.logger);
|
const frobber = new Frobber(context.controller, context.logger);
|
||||||
await frobber.load();
|
await frobber.load();
|
||||||
|
context.controller.hooks.save.attach(context.plugin.name, () => frobber.save());
|
||||||
Frobber.instances.set(context.controller, frobber);
|
Frobber.instances.set(context.controller, frobber);
|
||||||
return frobber;
|
return frobber;
|
||||||
}
|
}
|
||||||
@@ -162,12 +163,10 @@ export class Frobber {
|
|||||||
async save() { /* ... */ }
|
async save() { /* ... */ }
|
||||||
}
|
}
|
||||||
|
|
||||||
export default async function(context: ControllerPluginContext) {
|
export default Frobber.fromContext;
|
||||||
const frobber = await Frobber.fromContext(context);
|
|
||||||
context.controller.hooks.save.attach(context.plugin.name, () => frobber.save());
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The loader calls the default export without `this`, so refer to the class by name inside `fromContext` rather than using `this`.
|
||||||
Don't extend the deprecated base classes for this, they attach `on*` methods to hooks themselves and log a warning.
|
Don't extend the deprecated base classes for this, they attach `on*` methods to hooks themselves and log a warning.
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user