Fix: RoomObject.effects can be undefined

screepers · Sep 15, 2023 · 2f426c0 · 2f426c0
1 parent ae52290
commit 2f426c0
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -22,6 +22,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Fix: Mark `Spawning.directions` as optional ([#244](https://github.com/screepers/typed-screeps/pull/244))
 - Fix: Unlimited stores have no notion of free capacity ([#208](https://github.com/screepers/typed-screeps/pull/208))
 - Fix: `Room.getEventLog()` may return string ([#245](https://github.com/screepers/typed-screeps/pull/245))
+- FIx: Mark `RoomObject.effects` as optional
 
 ### Removed
 

diff --git a/dist/index.d.ts b/dist/index.d.ts
@@ -3759,7 +3759,7 @@ interface RoomObject {
     /**
      * Applied effects, an array of objects with the following properties:
      */
-    effects: RoomObjectEffect[];
+    effects?: RoomObjectEffect[];
     /**
      * An object representing the position of this object in the room.
      */

diff --git a/dist/screeps-tests.ts b/dist/screeps-tests.ts
@@ -105,7 +105,7 @@ function resources(o: GenericStore): ResourceConstant[] {
             } else {
                 // Boost resource
                 const targetSource = Game.getObjectById("targetSourceID" as Id<Source>)!;
-                const sourceEffect = targetSource.effects.find((effect) => effect.effect === PWR_REGEN_SOURCE && effect.level > 0);
+                const sourceEffect = targetSource.effects?.find((effect) => effect.effect === PWR_REGEN_SOURCE && effect.level > 0);
                 if (!sourceEffect && powerCreep.powers[PWR_REGEN_SOURCE] && powerCreep.powers[PWR_REGEN_SOURCE].cooldown === 0) {
                     powerCreep.usePower(PWR_REGEN_SOURCE, targetSource);
                 }
@@ -1361,6 +1361,19 @@ function atackPower(creep: Creep) {
     }
 }
 
+// Room Object
+{
+    // `RoomObject.effects` can be undefined
+    {
+        const source = new Source("" as Id<Source>);
+        // @ts-expect-error
+        source.effects.find((effect) => effect.effect === PWR_REGEN_SOURCE);
+
+        // no error with optional chaining operator
+        source.effects?.find((effect) => effect.effect === PWR_REGEN_SOURCE);
+    }
+}
+
 // Id
 {
     /// @ts-expect-error

diff --git a/src/room-object.ts b/src/room-object.ts
@@ -8,7 +8,7 @@ interface RoomObject {
     /**
      * Applied effects, an array of objects with the following properties:
      */
-    effects: RoomObjectEffect[];
+    effects?: RoomObjectEffect[];
     /**
      * An object representing the position of this object in the room.
      */