API Docs for: 0.10.0
Show:

Server Class

Defined in: lib/server.js:13
Module: yuidoc

Provides the --server server option for YUIDoc

Item Index

Methods

Properties

Methods

clazz

(
  • req
  • res
)

Defined in lib/server.js:140

/classes endpoint

Parameters:

files

(
  • req
  • res
)

Defined in lib/server.js:114

/files endpoint

Parameters:

home

(
  • req
  • res
)

Defined in lib/server.js:172

/ endpoint

Parameters:

init

()

Defined in lib/server.js:184

Creates the Express server and prep's YUI for serving

modules

(
  • req
  • res
)

Defined in lib/server.js:156

/modules endpoint

Parameters:

parse

(
  • req
  • res
  • next
)

Defined in lib/server.js:26

Middleware to parse the API docs per request

Parameters:

routes

()

Defined in lib/server.js:44

Create the routes used to serve YUIDoc files dynamically

start

(
  • options
)

Defined in lib/server.js:200

Start the server with the supplied options.

Parameters:

  • options Object

    Server options

Properties

_externalData

Object private

Defined in lib/server.js:19

Cache for external mixed in data.