isaacscript-common 77.2.0 → 77.2.1

package/dist/functions/storyBosses.d.ts

@@ -1,5 +1,9 @@
 import { BossID, EntityType } from "isaac-typescript-definitions";
 declare const STORY_BOSS_IDS: readonly [BossID.MOM, BossID.MOMS_HEART, BossID.SATAN, BossID.IT_LIVES, BossID.ISAAC, BossID.BLUE_BABY, BossID.LAMB, BossID.MEGA_SATAN, BossID.ULTRA_GREED, BossID.HUSH, BossID.DELIRIUM, BossID.ULTRA_GREEDIER, BossID.MOTHER, BossID.MAUSOLEUM_MOM, BossID.MAUSOLEUM_MOMS_HEART, BossID.DOGMA, BossID.BEAST];
+/**
+ * A helper type that is a union of every story boss. Useful for data structures that must contain
+ * one entry for each story boss.
+ */
 export type StoryBossID = (typeof STORY_BOSS_IDS)[number];
 /**
  * Helper function to determine if the specified entity type is an end-game story boss, like Isaac,
@@ -12,6 +16,6 @@ export declare function isStoryBoss(entityType: EntityType): boolean;
  * Baby, Mega Satan, The Beast, and so on. This is useful because certain effects should only apply
  * to non-story bosses, like Vanishing Twin.
  */
-export declare function isStoryBossID(bossID: BossID): boolean;
+export declare function isStoryBossID(bossID: BossID): bossID is StoryBossID;
 export {};
 //# sourceMappingURL=storyBosses.d.ts.map

package/dist/functions/storyBosses.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storyBosses.d.ts","sourceRoot":"","sources":["../../src/functions/storyBosses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAGlE,QAAA,MAAM,cAAc,gTAkBV,CAAC;AAyBX,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1D;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAE3D;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAErD"}
+{"version":3,"file":"storyBosses.d.ts","sourceRoot":"","sources":["../../src/functions/storyBosses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAGlE,QAAA,MAAM,cAAc,gTAkBV,CAAC;AAyBX;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1D;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAE3D;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,IAAI,WAAW,CAEnE"}

package/dist/index.rollup.d.ts

@@ -10136,7 +10136,7 @@ export declare function isStoryBoss(entityType: EntityType): boolean;
  * Baby, Mega Satan, The Beast, and so on. This is useful because certain effects should only apply
  * to non-story bosses, like Vanishing Twin.
  */
-export declare function isStoryBossID(bossID: BossID): boolean;
+export declare function isStoryBossID(bossID: BossID): bossID is StoryBossID;
 
 export declare function isString(variable: unknown): variable is string;
 
@@ -18633,6 +18633,10 @@ export declare function stopAllSoundEffects(soundEffectCustom?: TranspiledEnum):
 
 declare const STORY_BOSS_IDS: readonly [BossID.MOM, BossID.MOMS_HEART, BossID.SATAN, BossID.IT_LIVES, BossID.ISAAC, BossID.BLUE_BABY, BossID.LAMB, BossID.MEGA_SATAN, BossID.ULTRA_GREED, BossID.HUSH, BossID.DELIRIUM, BossID.ULTRA_GREEDIER, BossID.MOTHER, BossID.MAUSOLEUM_MOM, BossID.MAUSOLEUM_MOMS_HEART, BossID.DOGMA, BossID.BEAST];
 
+/**
+ * A helper type that is a union of every story boss. Useful for data structures that must contain
+ * one entry for each story boss.
+ */
 export declare type StoryBossID = (typeof STORY_BOSS_IDS)[number];
 
 /** From: https://gist.github.com/ryandabler/8b4ff4f36aed47bc09acc03174638468 */

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 77.1.0
+isaacscript-common 77.2.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "77.2.0",
+  "version": "77.2.1",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/functions/storyBosses.ts

@@ -44,6 +44,10 @@ const STORY_BOSS_ENTITY_TYPES_SET = new ReadonlySet([
 
 const STORY_BOSS_IDS_SET = new ReadonlySet<BossID>(STORY_BOSS_IDS);
 
+/**
+ * A helper type that is a union of every story boss. Useful for data structures that must contain
+ * one entry for each story boss.
+ */
 export type StoryBossID = (typeof STORY_BOSS_IDS)[number];
 
 /**
@@ -60,6 +64,6 @@ export function isStoryBoss(entityType: EntityType): boolean {
  * Baby, Mega Satan, The Beast, and so on. This is useful because certain effects should only apply
  * to non-story bosses, like Vanishing Twin.
  */
-export function isStoryBossID(bossID: BossID): boolean {
+export function isStoryBossID(bossID: BossID): bossID is StoryBossID {
   return STORY_BOSS_IDS_SET.has(bossID);
 }