API Reference Wayfinder v#0.1.0

View Source

Modules

Custom Wayfinder-specific error struct and reason definitions.

This module is responsible for writing generated Typescript code to the destination folder

Options for Wayfinder route generation.

After your Phoenix application is compiled the Typescript routes will be generated

We get for each route a map of all their arguments and if they are optional or not.

Handle %Phoenix.Router.Route{} entries — These are the steps in this module.

Handles filtering of Phoenix routes based on ignore patterns configured in the application.

Extracts {line, file} metadata for a given controller and action.

Represents a simplified Phoenix route for TypeScript generation.

A GenServer that watches for changes to router files and regenerates routes.

Generates a Typescript code for a controller / action Each action can have one or more routes, and each route can have one or more HTTP methods. When user define this kind of routes

Generates a Typescript controller for a given route. The controller includes all actions found in the Phoenix router.

Mix Tasks

Generates TypeScript routes based on your Phoenix router routes.