@scm-js/plugin-api 1.68.0 → 1.69.0

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.
Files changed (2) hide show
  1. package/index.d.ts +5 -4
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -4348,9 +4348,10 @@ export interface GameDataSource {
4348
4348
  /** Set when the desktop app extracted the files from a StarCraft installation. */
4349
4349
  desktop: boolean;
4350
4350
  /**
4351
- * The data set's hash, where one is known: what a map saved with it records. Sixteen hex
4352
- * digits over the files of the set that differ from the game's, by the rule `scmjs mod
4353
- * play` hands the play page (`docs/cli.md`, "Playing a mod on the play page").
4351
+ * The data set's hash, where one is known: what a map saved with it records. The mod's
4352
+ * hash, as the play page and `scmjs mod info` work it out (`docs/mods.md`, "The mod's
4353
+ * hash"): sixteen hex digits over every file the set provides — its game files, the
4354
+ * plugins it carries and its FireGraft project — never compared with anyone's copy.
4354
4355
  */
4355
4356
  hash?: string;
4356
4357
  /**
@@ -4523,7 +4524,7 @@ export interface GameDataApi {
4523
4524
  * @example
4524
4525
  * // Draw from the edit at once, and name it when its digest is ready.
4525
4526
  * api.gameData.reload();
4526
- * api.gameData.rehash(await digestOfChangedFiles());
4527
+ * api.gameData.rehash(await modHashOfTheFiles());
4527
4528
  */
4528
4529
  rehash(hash: string | null): GameDataSource | null;
4529
4530
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@scm-js/plugin-api",
3
- "version": "1.68.0",
3
+ "version": "1.69.0",
4
4
  "description": "Type declarations for the scmJS plugin API",
5
5
  "license": "MIT",
6
6
  "types": "index.d.ts",