Serialization

The serialization API preserves grid topology, dimensions, and open edge IDs. It does not serialize a Maze instance or StepPlayer.

For a complete persistence flow, see Saving and Restoring a Maze.

serializeGrid()

Returns a JSON-safe topology value:

function serializeGrid(grid: MazeGrid): SerializedMaze

interface SerializedMaze {
  type?: 'square' | 'triangle'
  triangleLayout?: 'triangle' | 'rectangle'
  size?: number
  rows: number
  cols: number
  openedEdgeIds: string[]
}

import { serializeGrid } from 'mazely'

const data = serializeGrid(maze.grid)
const json = JSON.stringify(data)

applySerializedGrid()

Applies serialized open-edge state to a compatible grid:

function applySerializedGrid(
  grid: MazeGrid,
  data: SerializedMaze,
): void

import {
  applySerializedGrid,
  createMaze,
} from 'mazely'

const restoredMaze = createMaze({
  grid: {
    type: 'square',
    rows: data.rows,
    cols: data.cols,
  },
})

applySerializedGrid(restoredMaze.grid, data)

The target dimensions must match. Unknown edge IDs are rejected before the grid is modified.

Serialized Scope

The format preserves:

• grid type and triangle boundary shape
• rows and columns
• triangle side size
• open and closed internal edges

It does not preserve:

• generation or solving algorithm state
• playback position or buffered steps
• solve visits or path metadata
• appearance settings
• a mask as a separate field

When restoring a masked grid, construct the target with the same mask before applying its serialized edge IDs.