lien

An easy to use web framework for Node.js.

☁️ Installation

# Using npm
npm install --save lien
# Using yarn
yarn add lien

📋 Example

constLien=require("lien");// Init lien serverconstserver=newLien({port: 9000,public: `${__dirname}/public`});// Listen for loadserver.on("load",err=>{console.log(err||"Server started on port 9000.");err&&process.exit(1);});// Add pageserver.get("/",lien=>{lien.end("Hello World");});// Add a dynamic routeserver.get("/post/:id",lien=>{lien.end("Post id: "+lien.params.id);});// Add a static fileserver.get("/test","index.html");// Listen for server errorsserver.on("serverError",err=>{console.log(err.stack);});

❓ Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. 🐛
3. For direct and quick help, you can use Codementor. 🚀

📝 Documentation

LienCreator(req, res, next, server)

Creates the lien object.

Params

• Objectreq: The request object.
• Objectres: The response object.
• Functionnext: The next middleware function.
• Objectserver: 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

• StringnewUrl: The new url to redirect to.
• Boolean|Objectquery: 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

• Stringtemplate: The template name.
• Objectdata: The template data.

startSession(data)

Starts a session.

Params

• Objectdata: The session data.

setSessionData(data)

Sets the session data.

Params

• Objectdata: The session data.

getSessionData(field)

Returns the session data object/specific field.

Params

• Fieldfield: 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

• Stringname: The header name.
• Stringvalue: 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

• Stringmsg: The API message.
• Numberstatus: The status code (default: 200).

apiError(msg, status)

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

Params

• Stringmsg: The API message.
• Numberstatus: The status code (default: 422).

end(content, status, contentType, headers)

Ends the response sending the content.

Params

• Anythingcontent: The content that should be sent to the response.
• Numberstatus: The status code.
• StringcontentType: The content type (e.g. "json").
• Objectheaders: Additional headers to send in the response.

cookie(cookie, value)

Sets, gets or deletes the cookie.

Params

• Stringcookie: The searched cookie.
• Stringvalue: 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|undefinednull, 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

• Stringpath: Relative path to the file.
• StringcustomRoot: 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

• Objectopt_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

• Stringurl: The static path url endpoint.
• StringlocalPath: The local path to the directory.

addPage(url, method, output)

Adds a new page to be handled.

Params

• Stringurl: The page url.
• String|Objectmethod: 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.
• Functionoutput: A function receiving the lien object as parameter. If can be a path serving a public file.

errorPages(options)

Handle the error pages.

Params

• Objectoptions: 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

• Stringtype: The hook type (before or after).
• Stringurl: The url.
• Stringmethod: 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

• Stringtype: The hook type (before or after).
• Stringurl: The url.
• Stringmethod: The method.

Return

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

insertHook(type, url, method, trans)

Inserts a new hook.

Params

• Stringtype: The hook type (before, after, custom:name).
• Stringurl: The url.
• Stringmethod: The method.
• Transformertrans: The transformer to insert.

Return

• Transformer The inserted transformer.

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

Adds a new hook.

Params

• Stringwhere: The hook type (before or after).
• Stringurl: The route url.
• Stringmethod: The HTTP method.
• Functioncb: The callback function.
• NumbertransType: The transformer type.

before(url, method, cb, transType)

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

Params

• Stringurl: The route url.
• Stringmethod: The HTTP method.
• Functioncb: The callback function.
• NumbertransType: The transformer type.

after(url, method, cb, transType)

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

Params

• Stringurl: The route url.
• Stringmethod: The HTTP method.
• Functioncb: The callback function.
• NumbertransType: The transformer type.

use(url, method, cb, transType)

Use this function to add middleware handlers.

Params

• Stringurl: The route url.
• Stringmethod: The HTTP method.
• Functioncb: The callback function.
• NumbertransType: The transformer type.

add(url, method, cb)

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

Params

• Stringurl: The endpoint url.
• Stringmethod: The HTTP method (default: all).
• Functioncb: The callback function.

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💖 Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like 🚀

• —I love books! I will remember you after years if you buy me one. 😁 📖

• —You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! ❤️

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list. ✨

• @dottjt/mediareade
• @everything-registry/sub-chunk-2069
• bloggify
• bloggify-cli
• bloggify-prebuilt
• bloggify-server-prebuilt
• bnotify
• chewb-youtube-uploader
• fb-token-updater
• gh-contributions
• learning-node-file-upload
• learning-nodejs-file-upload
• lien-github-comments-example
• nodejs-youtube-uploader
• test-youtube-api
• web-term
• wrabbit
• youtube-album-uploader
• youtube-album-uploader-multiple

📜 License

MIT © Ionică Bizău