Skip to content

DOCUMENTATION.md

Latest commit

 

History

History
298 lines (204 loc) · 9.95 KB

DOCUMENTATION.md

File metadata and controls

298 lines (204 loc) · 9.95 KB

Documentation

You can see below the API reference of this module.

LienCreator(req, res, next, server)

Creates the lien object.

Params

  • Object req: The request object.
  • Object res: The response object.
  • Function next: The next middleware function.
  • Object server: The Lien server instance.

Return

  • Lien The lien object.

next()

Go to the next middleware handler.

Return

  • Lien The Lien instance.

redirect(newUrl, query)

Redirects the client to another url.

Params

  • String newUrl: The new url to redirect to.
  • Boolean|Object query: If true, the request querystring parameters will be appended. If it's an object, it will be merged with the request querystring parameters.

render(template, data)

Renders a template to the client.

Params

  • String template: The template name.
  • Object data: The template data.

startSession(data)

Starts a session.

Params

  • Object data: The session data.

setSessionData(data)

Sets the session data.

Params

  • Object data: The session data.

getSessionData(field)

Returns the session data object/specific field.

Params

  • Field field: A specific field to get from the session object.

Return

  • Value|Object The field value. If a field is not specified, the whole session data object is returned.

destroySession()

Destroys the session.

header(name, value)

Gets/sets/deletes headers.

Params

  • String name: The header name.
  • String value: The header value to set. If null, the header will be removed.

Return

  • Lien The Lien instance.

apiMsg(msg, status)

Sends to the client a JSON object containing the message field.

Params

  • String msg: The API message.
  • Number status: The status code (default: 200).

apiError(msg, status)

Like apiMsg, but by default with a status code of 422.

Params

  • String msg: The API message.
  • Number status: The status code (default: 422).

end(content, status, contentType, headers)

Ends the response sending the content.

Params

  • Anything content: The content that should be sent to the response.
  • Number status: The status code.
  • String contentType: The content type (e.g. "json").
  • Object headers: Additional headers to send in the response.

cookie(cookie, value)

Sets, gets or deletes the cookie.

Params

  • String cookie: The searched cookie.
  • String value: If provided and it not null, the cookie will be set. If it's null, the cookie will be deleted. If value is not provided, the cookie value will be returned.

Return

  • String|null|undefined null, if the cookie was deleted. undefined if the cookie doesn't exist. The cookie value if this exists.

file(path, customRoot)

Serves a file to the response.

Params

  • String path: Relative path to the file.
  • String customRoot: Absolute path to the root directory (optional).

Lien(opt_options)

Creates a new Lien instance.

It extends the EventEmitter class.

It emits the following events:

  • load (err): After the server is started. If there are no errors, the err will be null.
  • serverError (err, req, res): This is emitted when something goes wrong after the server is started.
  • error (err): Errors which may appear during the server initialization.

Params

  • Object opt_options: An object containing the following properties:

    • host (String): The server host.

    • port (Integer): The server port. process.env.PORT is used, default is 3000.

    • session (Boolean|Object): Enable the session support. If it's an object, it will be merged with the following defaults and passed to express-session:

      • secret (String): This is the secret used to sign the session ID cookie (default: "lien server").
      • resave (Boolean): Forces the session to be saved back to the session store, even if the session was never modified during the request (default: false).
      • saveUninitialized (Boolean): Forces a session that is "uninitialized" to be saved to the store (default: true).
      • cookie (Object): The cookie options.
      • storeOptions (Object): The session store options. These options are passed to the session store you choose.
      • store: (String|Function): The session store name or function. By default it's using a memory store if the session is enabled.

    • public (String|Array): The path to the public directory or an array of arrays in this format: ["/url/of/static/dir", "path/to/static/dir"].

      Example:

      [
  ["/images", "path/to/images"]
, ["/", "path/to/public"]
]

    • ssl (Object): An object containing the following fields:

      • key (String): The path to the key file.
      • cert (String): The path to the cert file.
      • _key (String|Buffer): The key file content (defaults to the key file content).
      • _cert (String|Buffer): The cert file content (defaults to the cert file content).

    • views

      • path (String): The path to the views directory.
      • name (String): The view engine name.

    • errorPages (Object):

      • notFound (String|Function): The path to a custom 404 page or a function receiving the lien object as parameter. This can be used to serve custom 404 pages.
      • serverError (String|Function): The path to a custom 500 page or a function receiving the lien object as parameter. This can be used to serve custom 500 pages.
      • badCsrf (String|Function): The path to a custom bad CSRF page or a function receiving the lien object as parameter. This can be used to serve custom bad CSRF errors.

    • logErrors (Boolean): Log the server errors (default: true).

    • csrf (Object): The CSRF options. These are passed to csurf

    • bodyParserJson (Boolean): Whether to enable the JSON body parser (default: true)

    • bodyParserUrlEncoded (Boolean): Whether to enable the URL encoded body parser (default: true)

    • cookieParser (Boolean): Whether to enable the cookie parser (default: true)

    • transformers (Boolean): Whether to enable the transformers (default: true)

Return

  • Object The Lien instance.

addStaticPath(url, localPath)

Adds a new static path to the server.

Params

  • String url: The static path url endpoint.
  • String localPath: The local path to the directory.

addPage(url, method, output)

Adds a new page to be handled.

Params

  • String url: The page url.
  • String|Object method: The request methods to be handled (default: "all") or an object:
    • method (String): The HTTP method.
    • before (Array|Function): A function or an array of middleware functions to be executed before the main function.
    • after (Array|Function): A function or an array of middleware functions to be executed after the main function.
  • Function output: A function receiving the lien object as parameter. If can be a path serving a public file.

errorPages(options)

Handle the error pages.

Params

  • Object options: An object containing the following fields:
  • notFound (String|Function): The path to a custom 404 page or a function receiving the lien object as parameter. This can be used to serve custom 404 pages.
  • serverError (String|Function): The path to a custom 500 page or a function receiving the lien object as parameter. This can be used to serve custom 500 pages.

getHooks(type, url, method)

Gets the transformer for a url.

Params

  • String type: The hook type (before or after).
  • String url: The url.
  • String method: The method.

Return

  • Transformer|null The transformer (if it exists) or null.

getHooksStrict(type, url, method)

Similar to getHooks, but doesn't concat hooks based on the regex matching but only if they are the same regex.

Params

  • String type: The hook type (before or after).
  • String url: The url.
  • String method: The method.

Return

  • Transformer|null The transformer (if it exists) or null.

insertHook(type, url, method, trans)

Inserts a new hook.

Params

  • String type: The hook type (before, after, custom:name).
  • String url: The url.
  • String method: The method.
  • Transformer trans: The transformer to insert.

Return

  • Transformer The inserted transformer.

hook(where, url, method, cb, transType)

Adds a new hook.

Params

  • String where: The hook type (before or after).
  • String url: The route url.
  • String method: The HTTP method.
  • Function cb: The callback function.
  • Number transType: The transformer type.

before(url, method, cb, transType)

Adds a before hook. It will handle all the subroutes of the url.

Params

  • String url: The route url.
  • String method: The HTTP method.
  • Function cb: The callback function.
  • Number transType: The transformer type.

after(url, method, cb, transType)

Adds a before hook. It will handle all the subroutes of the url.

Params

  • String url: The route url.
  • String method: The HTTP method.
  • Function cb: The callback function.
  • Number transType: The transformer type.

use(url, method, cb, transType)

Use this function to add middleware handlers.

Params

  • String url: The route url.
  • String method: The HTTP method.
  • Function cb: The callback function.
  • Number transType: The transformer type.

add(url, method, cb)

Adds a new middleware. Note: This will not trigger the hooks.

Params

  • String url: The endpoint url.
  • String method: The HTTP method (default: all).
  • Function cb: The callback function.