# lien > An easy to use web framework for Node.js. Latest version **4.0.0** (published 2024-01-01) · MIT license · 189 weekly downloads ## Install ```sh npm install lien pnpm add lien yarn add lien bun add lien ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned. ## Facts | | | |---|---| | Version | 4.0.0 | | Published | 2024-01-01 | | First published | 2014-10-23 | | Weekly downloads | 189 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 13 | | Unpacked size | 81.4 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 10 | | Author | Ionică Bizău | | Maintainers | ionicabizau | | Keywords | lien, link, request, response, framework | ## Links - npm: https://www.npmjs.com/package/lien - Repository: https://github.com/LienJS/Lien - Issues: https://github.com/LienJS/Lien/issues - npm.io page: https://npm.io/package/lien ## Dependencies (13) - [ul](https://npm.io/package/ul.md) ^5.2.1 - [csurf](https://npm.io/package/csurf.md) ^1.9.0 - [noop6](https://npm.io/package/noop6.md) ^1.0.2 - [express](https://npm.io/package/express.md) ^4.13.4 - [methods](https://npm.io/package/methods.md) ^1.1.2 - [find-value](https://npm.io/package/find-value.md) ^1.0.1 - [set-or-get](https://npm.io/package/set-or-get.md) ^1.2.2 - [body-parser](https://npm.io/package/body-parser.md) ^1.15.0 - [transformer](https://npm.io/package/transformer.md) ^1.0.1 - [cookie-parser](https://npm.io/package/cookie-parser.md) ^1.4.3 - [iterate-object](https://npm.io/package/iterate-object.md) ^1.3.2 - [path-to-regexp](https://npm.io/package/path-to-regexp.md) ^6.2.1 - [express-session](https://npm.io/package/express-session.md) ^1.13.0 ## Alternatives - [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads - [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads - [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads - [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads - [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads ## Recent versions - 4.0.0 (latest) — 2024-01-01 - 3.4.4 — 2023-12-27 - 3.4.3 — 2023-10-01 - 3.4.2 — 2023-02-13 - 3.4.1 — 2023-02-12 - 3.4.0 — 2023-02-12 - 3.3.1 — 2020-08-10 - 3.3.0 — 2018-10-19 - 3.2.0 — 2018-02-12 - 3.1.1 — 2017-10-15 - 3.1.0 — 2017-08-29 - 3.0.4 — 2017-05-30 - 3.0.3 — 2017-05-26 - 3.0.2 — 2017-05-26 - 3.0.1 — 2017-05-07 - … 45 more at https://npm.io/package/lien/versions ## README [![lien](https://raw.githubusercontent.com/LienJS/Resources/master/logo/header.png)](#) # lien [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Travis](https://img.shields.io/travis/LienJS/Lien.svg)](https://travis-ci.org/LienJS/Lien/) [![Version](https://img.shields.io/npm/v/lien.svg)](https://www.npmjs.com/package/lien) [![Downloads](https://img.shields.io/npm/dt/lien.svg)](https://www.npmjs.com/package/lien) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github) Buy Me A Coffee > An easy to use web framework for Node.js. ## :cloud: Installation ```sh # Using npm npm install --save lien # Using yarn yarn add lien ``` ## :clipboard: Example ```js const Lien = require("lien"); // Init lien server const server = new Lien({ port: 9000 , public: `${__dirname}/public` }); // Listen for load server.on("load", err => { console.log(err || "Server started on port 9000."); err && process.exit(1); }); // Add page server.get("/", lien => { lien.end("Hello World"); }); // Add a dynamic route server.get("/post/:id", lien => { lien.end("Post id: " + lien.params.id); }); // Add a static file server.get("/test", "index.html"); // Listen for server errors server.on("serverError", err => { console.log(err.stack); }); ``` ## :question: Get Help There are few ways to get help: 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). 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. :bug: 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket: ## :memo: Documentation ### `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`](https://github.com/expressjs/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](https://github.com/expressjs/cookie-parser). - `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: ```js [ ["/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`](https://github.com/expressjs/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. ## :yum: How to contribute Have an idea? Found a bug? See [how to contribute][contributing]. ## :sparkling_heart: 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 :rocket: - [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book: - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea: - [![Support me on Patreon][badge_patreon]][patreon]—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` ![](https://i.imgur.com/z6OQI95.png) Thanks! :heart: ## :dizzy: Where is this library used? If you are using this library in one of your projects, add it in this list. :sparkles: - `@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` ## :scroll: License [MIT][license] © [Ionică Bizău][website] [license]: /LICENSE [website]: https://ionicabizau.net/ [contributing]: /CONTRIBUTING.md [docs]: /DOCUMENTATION.md [badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg [badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg [badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg [badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg [patreon]: https://www.patreon.com/ionicabizau [amazon]: http://amzn.eu/hRo9sIZ [paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW --- _Source: https://npm.io/package/lien · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._