API Docs for:
Show:

Server Class

Provides the --server server option for YUIDoc

Item Index

Properties

Methods

clazz

(
  • req
  • res
)

/classes endpoint

Parameters:

  • req Request

    Express request object

  • res Response

    Express response object

files

(
  • req
  • res
)

/files endpoint

Parameters:

  • req Request

    Express request object

  • res Response

    Express response object

home

(
  • req
  • res
)

/ endpoint

Parameters:

  • req Request

    Express request object

  • res Response

    Express response object

init

()

Creates the Express server and prep's YUI for serving

modules

(
  • req
  • res
)

/modules endpoint

Parameters:

  • req Request

    Express request object

  • res Response

    Express response object

parse

(
  • req
  • res
  • next
)

Middleware to parse the API docs per request

Parameters:

  • req Request

    Express request object

  • res Response

    Express response object

  • next Function

    Express next callback

routes

()

Create the routes used to serve YUIDoc files dynamically

start

(
  • options
)

Start the server with the supplied options.

Parameters:

  • options Object

    Server options

Properties

_externalData

Object private

Cache for external mixed in data.