Module

Payload.Spec

Package
purescript-payload
Repository
hoodunit/purescript-payload

This module contains all of the types and kinds that can appear in an API spec.

#Spec Source

data Spec apiSpec

Constructors

#Route Source

data Route (method :: Symbol) (path :: Symbol) spec

Constructors

#GET Source

type GET = Route "GET"

#HEAD Source

type HEAD = Route "HEAD"

#OPTIONS Source

type OPTIONS = Route "OPTIONS"

#POST Source

type POST = Route "POST"

#PUT Source

type PUT = Route "PUT"

#DELETE Source

type DELETE = Route "DELETE"

#Routes Source

data Routes (path :: Symbol) routesSpec

Constructors

#Guards Source

data Guards (g :: GuardList)

Type-level list of guard names that will be run before calling a route or child routes.

Constructors

#GuardList Source

#GNil Source

data GNil :: GuardList

#type (:) Source

Operator alias for Payload.Spec.GCons (right-associative / precedence 1)

#Nil Source

type Nil = GNil