Server Class
Provides the --server
server option for YUIDoc
Methods
clazz
(
-
req
-
res
/classes
endpoint
Parameters:
-
req
RequestExpress request object
-
res
ResponseExpress response object
files
(
-
req
-
res
/files
endpoint
Parameters:
-
req
RequestExpress request object
-
res
ResponseExpress response object
home
(
-
req
-
res
/
endpoint
Parameters:
-
req
RequestExpress request object
-
res
ResponseExpress response object
init
()
Creates the Express server and prep's YUI for serving
modules
(
-
req
-
res
/modules
endpoint
Parameters:
-
req
RequestExpress request object
-
res
ResponseExpress response object
parse
(
-
req
-
res
-
next
Middleware to parse the API docs per request
Parameters:
-
req
RequestExpress request object
-
res
ResponseExpress response object
-
next
FunctionExpress next callback
routes
()
Create the routes used to serve YUIDoc files dynamically
start
(
-
options
Start the server with the supplied options.
Parameters:
-
options
ObjectServer options