typed-screeps
Strong TypeScript declarations for the game Screeps.
Installation
The type definitions are published on DefinitelyTyped. To install them, run the following.
# npm npm install @types/screeps # yarn yarn add @types/screeps
Screeps-Typescript-Declarations
Differences fromBreaking Changes:
-
Memory
is typed by default. The added typings are:CreepMemory
FlagMemory
SpawnMemory
RoomMemory
If you like the idea of typed memory, but aren't ready to just jump fully in, you only need to make sure you define an interface for the above four types. Then you can extend them at a later time.
Example:
interface CreepMemory { [name: string]: any };interface FlagMemory { [name: string]: any };interface SpawnMemory { [name: string]: any };interface RoomMemory { [name: string]: any }; -
Any place in code that uses a constant (ex
STRUCTURE_EXTENSION
orFIND_MY_SPAWNS
is now constrained to use literal types. Here is the list of the new types:BodyPartConstant BuildableStructureConstant (this is a subset of StructureConstant) StructureConstant FindConstant LookConstant DirectionConstant ResourceConstant MineralConstant (this is a subset of ResourceConstant) ColorConstant ScreepsReturnCode Terrain
To update your code, you just need to change any
string
types to match one of the above. For example, if your code had:function getBody(): string[] {return [ WORK, MOVE, CARRY ];}Change it to:
function getBody(): BodyPartConstant[] { // this line changedreturn [ WORK, MOVE, CARRY ];} -
Some original functions were incorrectly typed to not include
null
as a possible return. You may need to update your code to reflect this update (ex.findClosestByPath
orfindClosestByRange
)
Additional (non-breaking) Features:
ConstructionSite
can be optionally constrained by a structure type (ex.ConstructionSite<STRUCTURE_CONTAINER>
). TypeScript will enforce that thetype
property of theConstructionSite
appropriately matchesResource
can optionally be constrained (ex.Resource<RESOURCE_ENERGY>
)Mineral
can optionally be constrained byMineralConstant
(ex.Mineral<RESOURCE_GHODIUM>
)Structure
can optionally be constrained (exStructure<STRUCTURE_SPAWN | STRUCTURE_EXTENSION>
)- Screeps classes derived from
Structure
(exStructureContainer
) have theirtype
property correspondingly constrained LookAt
results are now constrained to the type looked for- Results from
Find
-type functions are now constrained to have aRoomPosition
- Typings for new RawMemory and RoomVisuals
Contribute
Issues and Pull Requests are welcome! Please read the Contributing Guidelines and Code of Conduct beforehand.
Workarounds / Caveats
Due to some unresolved issues in TypeScript, a few parts of the API can't currenty be typed perfectly without tradeoffs.
Below is a list (feel free to open an issue if you have any ideas, or wish to discuss):
- The API returned from
store
orcarry
(ex.myContainter.store
) returns an object with optional keys for each Resource Type, but is guaranteed to have a key forRESOURCE_ENERGY
. This is currently not (perfectly) typable in TypeScript (see issues #13573 and #12215). The chosen workaround is to just manually list the types using a fake type_ResourceConstantSansEnergy