Module

Yoga.Fastify.Fastify

Package: purescript-yoga-fastify
Repository: rowtype-yoga/purescript-yoga-fastify

#Fastify Source

data Fastify

Opaque Fastify instance

#FastifyRequest Source

data FastifyRequest

Opaque request object

#FastifyReply Source

data FastifyReply

Opaque reply object

#RouteHandler Source

type RouteHandler = FastifyRequest -> FastifyReply -> Aff Unit

Route handler type: takes request and reply, returns Aff Unit

#HttpServer Source

data HttpServer

#HttpRequest Source

data HttpRequest

#HttpResponse Source

data HttpResponse

#NetSocket Source

data NetSocket

#Buffer Source

data Buffer

#Host Source

newtype Host

Constructors

Host String

Instances

Newtype Host _
Show Host

#Port Source

newtype Port

Constructors

Port Int

Instances

Newtype Port _
Show Port

#HTTPMethod Source

newtype HTTPMethod

Constructors

HTTPMethod String

Instances

Newtype HTTPMethod _
Show HTTPMethod

#RouteURL Source

newtype RouteURL

Constructors

RouteURL String

Instances

Newtype RouteURL _
Show RouteURL

#StatusCode Source

newtype StatusCode

Constructors

StatusCode Int

Instances

Newtype StatusCode _
Show StatusCode

#AjvOptions Source

newtype AjvOptions

Constructors

AjvOptions Foreign

Instances

Newtype AjvOptions _

#JsonSchema Source

newtype JsonSchema

Constructors

JsonSchema Foreign

Instances

Newtype JsonSchema _

#RouteSchema Source

newtype RouteSchema

Constructors

RouteSchema Foreign

Instances

Newtype RouteSchema _

#RouteConfig Source

newtype RouteConfig

Constructors

RouteConfig Foreign

Instances

Newtype RouteConfig _

#RequestParsers Source

newtype RequestParsers

#CookieParser Source

newtype CookieParser

#FormBodyParser Source

newtype FormBodyParser

#MultipartParser Source

newtype MultipartParser

#MultipartLimits Source

newtype MultipartLimits

#ajvOptions Source

ajvOptions :: forall opts opts_. Union opts opts_ AjvCustomOptionsImpl => Record opts -> AjvOptions

#routeSchema Source

routeSchema :: forall opts opts_. Union opts opts_ RouteSchemaImpl => Record opts -> RouteSchema

#routeConfig Source

routeConfig :: forall opts opts_. Union opts opts_ RouteConfigImpl => Record opts -> RouteConfig

#requestParsers Source

requestParsers :: forall opts opts_. Union opts opts_ RequestParsersImpl => Record opts -> RequestParsers

Configure or disable the request parsers installed by fastify. Omitted entries retain the safe defaults, including multipart key-value bodies.

#cookieParser Source

cookieParser :: forall opts opts_. Union opts opts_ CookieParserOptionsImpl => Record opts -> CookieParser

#disableCookieParser Source

disableCookieParser :: CookieParser

#formBodyParser Source

formBodyParser :: forall opts opts_. Union opts opts_ FormBodyParserOptionsImpl => Record opts -> FormBodyParser

#disableFormBodyParser Source

disableFormBodyParser :: FormBodyParser

#multipartParser Source

multipartParser :: forall opts opts_. Union opts opts_ MultipartParserOptionsImpl => Record opts -> MultipartParser

#disableMultipartParser Source

disableMultipartParser :: MultipartParser

#multipartLimits Source

multipartLimits :: forall opts opts_. Union opts opts_ MultipartLimitsImpl => Record opts -> MultipartLimits

#ListenOptionsImpl Source

type ListenOptionsImpl :: Row Typetype ListenOptionsImpl = (host :: Host, port :: Port)

#RouteOptionsImpl Source

type RouteOptionsImpl :: Row Typetype RouteOptionsImpl = (config :: RouteConfig, method :: HTTPMethod, schema :: RouteSchema, url :: RouteURL)

#FastifyOptionsImpl Source

type FastifyOptionsImpl :: Row Typetype FastifyOptionsImpl = (ajv :: AjvOptions, bodyLimit :: Int, disableRequestLogging :: Boolean, logger :: Boolean, requestIdHeader :: String, requestIdLogLabel :: String, requestParsers :: RequestParsers)

#AjvCustomOptionsImpl Source

type AjvCustomOptionsImpl :: Row Typetype AjvCustomOptionsImpl = (allErrors :: Boolean, coerceTypes :: Boolean, removeAdditional :: Boolean)

#RouteSchemaImpl Source

type RouteSchemaImpl :: Row Typetype RouteSchemaImpl = (body :: JsonSchema, headers :: JsonSchema, params :: JsonSchema, querystring :: JsonSchema, response :: Foreign)

#RouteConfigImpl Source

type RouteConfigImpl :: Row Typetype RouteConfigImpl = (rateLimit :: Foreign)

#RequestParsersImpl Source

type RequestParsersImpl :: Row Typetype RequestParsersImpl = (cookie :: CookieParser, formBody :: FormBodyParser, multipart :: MultipartParser)

#CookieParserOptionsImpl Source

type CookieParserOptionsImpl :: Row Typetype CookieParserOptionsImpl = (algorithm :: String, hook :: String, secret :: String)

#FormBodyParserOptionsImpl Source

type FormBodyParserOptionsImpl :: Row Typetype FormBodyParserOptionsImpl = (bodyLimit :: Int)

#MultipartParserOptionsImpl Source

type MultipartParserOptionsImpl :: Row Typetype MultipartParserOptionsImpl = (limits :: MultipartLimits, sharedSchemaId :: String)

#MultipartLimitsImpl Source

type MultipartLimitsImpl :: Row Typetype MultipartLimitsImpl = (fieldNameSize :: Int, fieldSize :: Int, fields :: Int, fileSize :: Int, files :: Int, headerPairs :: Int, parts :: Int)

#fastify Source

fastify :: forall opts opts_. Union opts opts_ FastifyOptionsImpl => Record opts -> Effect Fastify

#route Source

route :: forall opts opts_. Union opts opts_ RouteOptionsImpl => Record opts -> RouteHandler -> Fastify -> Effect Unit

#get Source

get :: RouteURL -> RouteHandler -> Fastify -> Effect Unit

Convenience: GET route

#post Source

post :: RouteURL -> RouteHandler -> Fastify -> Effect Unit

Convenience: POST route

#put Source

put :: RouteURL -> RouteHandler -> Fastify -> Effect Unit

Convenience: PUT route

#delete Source

delete :: RouteURL -> RouteHandler -> Fastify -> Effect Unit

Convenience: DELETE route

#patch Source

patch :: RouteURL -> RouteHandler -> Fastify -> Effect Unit

Convenience: PATCH route

#ready Source

ready :: Fastify -> Aff Unit

#listen Source

listen :: forall opts opts_. Union opts opts_ ListenOptionsImpl => Record opts -> Fastify -> Aff String

#close Source

close :: Fastify -> Aff Unit

#body Source

body :: FastifyRequest -> Effect (Maybe Foreign)

#params Source

params :: FastifyRequest -> Effect (Object String)

#query Source

query :: FastifyRequest -> Effect (Object Foreign)

#headers Source

headers :: FastifyRequest -> Effect (Object String)

#cookies Source

cookies :: FastifyRequest -> Effect (Object String)

#method Source

method :: FastifyRequest -> Effect HTTPMethod

#url Source

url :: FastifyRequest -> Effect RouteURL

#status Source

status :: StatusCode -> FastifyReply -> Effect FastifyReply

#send Source

send :: Foreign -> FastifyReply -> Aff Unit

#sendJson Source

sendJson :: Foreign -> FastifyReply -> Aff Unit

#rawRequest Source

rawRequest :: FastifyRequest -> Effect HttpRequest

#rawReply Source

rawReply :: FastifyReply -> Effect HttpResponse

#rawRoute Source

rawRoute :: Array String -> (HttpRequest -> HttpResponse -> Effect Unit) -> Fastify -> Effect Unit

#rawServer Source

rawServer :: Fastify -> Effect HttpServer

#onUpgrade Source

onUpgrade :: HttpServer -> (HttpRequest -> NetSocket -> Buffer -> Effect Unit) -> Effect Unit

#httpRequestUrl Source

httpRequestUrl :: HttpRequest -> Effect String

Modules: Yoga.Fastify.Auth.Argon2; Yoga.Fastify.Auth.JWT; Yoga.Fastify.Fastify; Yoga.Fastify.Plugin; Yoga.Fastify.Plugin.Cors; Yoga.Fastify.Plugin.Helmet; Yoga.Fastify.Plugin.RateLimit; Yoga.Fastify.Plugin.WebSocket; Yoga.Fastify.Route.HandleResponse; Yoga.Fastify.Route.HandleRoute; Yoga.Fastify.Route.ParseBody; Yoga.Fastify.Route.ParseCookies; Yoga.Fastify.Route.ParseHeaders; Yoga.Fastify.Route.ParsePathParams; Yoga.Fastify.Route.ParseQueryParams; Yoga.Fastify.Route.SetHeaders