@shardworks/nexus-core 0.1.274 → 0.1.275
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -1
- package/dist/guild.d.ts +18 -0
- package/dist/guild.d.ts.map +1 -1
- package/dist/guild.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -21,7 +21,8 @@ const config = guild().config<MyConfig>('my-plugin');
|
|
|
21
21
|
| Member | Returns | Description |
|
|
22
22
|
|---|---|---|
|
|
23
23
|
| `home` | `string` | Absolute path to the guild root |
|
|
24
|
-
| `apparatus<T>(name)` | `T` | Retrieve a started apparatus's `provides` object by plugin id |
|
|
24
|
+
| `apparatus<T>(name)` | `T` | Retrieve a started apparatus's `provides` object by plugin id. Throws if absent — use for `requires` dependencies |
|
|
25
|
+
| `tryApparatus<T>(name)` | `T \| null` | Optional counterpart to `apparatus<T>` — returns `null` when the apparatus is not installed. Use for `recommends` dependencies so the caller can branch on presence rather than catch a thrown error |
|
|
25
26
|
| `config<T>(pluginId)` | `T` | Read a plugin's configuration section from guild.json |
|
|
26
27
|
| `writeConfig<T>(pluginId, value)` | `void` | Write a plugin's configuration section to guild.json (updates in-memory + disk) |
|
|
27
28
|
| `guildConfig()` | `GuildConfig` | Read the full parsed guild.json |
|
package/dist/guild.d.ts
CHANGED
|
@@ -40,6 +40,24 @@ export interface Guild {
|
|
|
40
40
|
* (dependency ordering guarantees declared deps are started first).
|
|
41
41
|
*/
|
|
42
42
|
apparatus<T>(name: string): T;
|
|
43
|
+
/**
|
|
44
|
+
* Retrieve a started apparatus's provides object by plugin id, or
|
|
45
|
+
* `null` if the apparatus is not installed (or has no `provides`).
|
|
46
|
+
*
|
|
47
|
+
* The optional counterpart to {@link Guild.apparatus} — same arity,
|
|
48
|
+
* same generic, same caller ergonomics. Reach for this when the
|
|
49
|
+
* apparatus is in `recommends`, not `requires`, so the caller can
|
|
50
|
+
* branch on its presence rather than catching a thrown error.
|
|
51
|
+
*
|
|
52
|
+
* const clockworks = guild().tryApparatus<ClockworksApi>('clockworks');
|
|
53
|
+
* if (!clockworks) return; // optional dependency, soft no-op
|
|
54
|
+
*
|
|
55
|
+
* Use {@link Guild.apparatus} when the apparatus is a hard requirement
|
|
56
|
+
* (declared in `requires`) — its throw-on-missing behaviour fails
|
|
57
|
+
* loudly at the call site rather than silently no-op'ing past a
|
|
58
|
+
* misconfiguration.
|
|
59
|
+
*/
|
|
60
|
+
tryApparatus<T>(name: string): T | null;
|
|
43
61
|
/**
|
|
44
62
|
* Read a plugin's configuration section from guild.json.
|
|
45
63
|
*
|
package/dist/guild.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"guild.d.ts","sourceRoot":"","sources":["../src/guild.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAI5E;;;;;;;;GAQG;AACH,MAAM,WAAW,KAAK;IACpB,6DAA6D;IAC7D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAErB;;;;;;OAMG;IACH,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,CAAA;IAE7B;;;;;;OAMG;IACH,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,MAAM,GAAG,CAAC,CAAA;IAExD;;;;;;;;;OASG;IACH,WAAW,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAA;IAE1E;;;;;OAKG;IACH,WAAW,IAAI,WAAW,CAAA;IAE1B,6FAA6F;IAC7F,IAAI,IAAI,SAAS,EAAE,CAAA;IAEnB,2CAA2C;IAC3C,WAAW,IAAI,eAAe,EAAE,CAAA;IAEhC,mEAAmE;IACnE,aAAa,IAAI,YAAY,EAAE,CAAA;IAE/B,uGAAuG;IACvG,eAAe,IAAI,MAAM,EAAE,CAAA;CAC5B;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,YAAa,SAAQ,KAAK;IACzC;;;;;;;;;;;OAWG;IACH,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CAC1B;AAMD;;;;;GAKG;AACH,wBAAgB,KAAK,IAAI,KAAK,CAQ7B;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI,CAEvC;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,UAAU,IAAI,IAAI,CAEjC"}
|
|
1
|
+
{"version":3,"file":"guild.d.ts","sourceRoot":"","sources":["../src/guild.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAI5E;;;;;;;;GAQG;AACH,MAAM,WAAW,KAAK;IACpB,6DAA6D;IAC7D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAErB;;;;;;OAMG;IACH,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,CAAA;IAE7B;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI,CAAA;IAEvC;;;;;;OAMG;IACH,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,MAAM,GAAG,CAAC,CAAA;IAExD;;;;;;;;;OASG;IACH,WAAW,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAA;IAE1E;;;;;OAKG;IACH,WAAW,IAAI,WAAW,CAAA;IAE1B,6FAA6F;IAC7F,IAAI,IAAI,SAAS,EAAE,CAAA;IAEnB,2CAA2C;IAC3C,WAAW,IAAI,eAAe,EAAE,CAAA;IAEhC,mEAAmE;IACnE,aAAa,IAAI,YAAY,EAAE,CAAA;IAE/B,uGAAuG;IACvG,eAAe,IAAI,MAAM,EAAE,CAAA;CAC5B;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,YAAa,SAAQ,KAAK;IACzC;;;;;;;;;;;OAWG;IACH,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CAC1B;AAMD;;;;;GAKG;AACH,wBAAgB,KAAK,IAAI,KAAK,CAQ7B;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI,CAEvC;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,UAAU,IAAI,IAAI,CAEjC"}
|
package/dist/guild.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"guild.js","sourceRoot":"","sources":["../src/guild.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;
|
|
1
|
+
{"version":3,"file":"guild.js","sourceRoot":"","sources":["../src/guild.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAgIH,0EAA0E;AAE1E,IAAI,MAAM,GAAiB,IAAI,CAAC;AAEhC;;;;;GAKG;AACH,MAAM,UAAU,KAAK;IACnB,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CACb,+DAA+D;YAC/D,4EAA4E,CAC7E,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,QAAQ,CAAC,CAAQ;IAC/B,MAAM,GAAG,CAAC,CAAC;AACb,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,UAAU;IACxB,MAAM,GAAG,IAAI,CAAC;AAChB,CAAC"}
|