Package Exports

@workadventure/tiled-map-type-guard
@workadventure/tiled-map-type-guard/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@workadventure/tiled-map-type-guard) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Tiled map type guards

When working with Tiled maps, it can be useful to have property defined types in Typescript.

This package contains a set of interfaces that map the Tiled map JSON format.

Moreover, this package comes with Zod type guards that will allow you to actually check that the JSON file ou are reading is actually a well-formed Tiled map.

Available interfaces:

ITiledMap
ITiledMapLayer
- ITiledMapGroupLayer
- ITiledMapImageLayer
- ITiledMapObjectLayer
  - ITiledMapObject
    - ITiledMapText
    - ITiledMapPoint
- ITiledMapTileLayer
ITiledMapTileset
- ITiledMapTile
  - ITiledMapWangColor
  - ITiledMapWangSet
  - ITiledMapWangTile
ITiledMapChunk
ITiledMapFrame
ITiledMapGrid
ITiledMapOffset
ITiledMapProperty
ITiledMapTerrain
ITiledMapTransformations

Usage:

// This will throw an error if "data" is not matching the type ITiledMap
const map: ITiledMap = ITiledMap.parse(data);