diff options
Diffstat (limited to 'CLAUDE.md')
-rw-r--r-- | CLAUDE.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..b849fa7 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,25 @@ +# OCaml Routes Library DSL + +## The `@-->` Operator + +The `@-->` operator is from the `routes` library and is used to bind route patterns to handler functions. + +### Example: +```ocaml +`GET, (s "posts" /? nil) @--> Handler.get_posts +``` + +### Breaking it down: +- `s "posts"` - matches the string "posts" in the URL path +- `/?` - path concatenation operator +- `nil` - end of path (no more segments) +- `@-->` - "maps to" operator that binds the route to the handler + +So `(s "posts" /? nil) @--> Handler.get_posts` means "the route `/posts` maps to the `Handler.get_posts` function". + +### Other common operators in the routes library: +- `/:` for path parameters (e.g., `s "user" /: int /? nil` matches `/user/123`) +- `//` for wildcard paths +- `<$>` for transforming matched values + +It's a DSL (domain-specific language) for expressing routes in a concise, type-safe way.
\ No newline at end of file |