{"id":15680138,"url":"https://github.com/sholladay/hapi-perm","last_synced_at":"2025-03-30T09:28:02.829Z","repository":{"id":57149570,"uuid":"82492973","full_name":"sholladay/hapi-perm","owner":"sholladay","description":"RethinkDB storage for hapi web servers","archived":false,"fork":false,"pushed_at":"2020-01-13T18:41:28.000Z","size":27,"stargazers_count":1,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-14T00:26:14.969Z","etag":null,"topics":["connection","database","db","hapi","plugin","rethinkdb","server"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sholladay.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-02-19T22:07:26.000Z","updated_at":"2020-01-13T18:41:30.000Z","dependencies_parsed_at":"2022-09-03T18:11:34.332Z","dependency_job_id":null,"html_url":"https://github.com/sholladay/hapi-perm","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sholladay%2Fhapi-perm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sholladay%2Fhapi-perm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sholladay%2Fhapi-perm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sholladay%2Fhapi-perm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sholladay","download_url":"https://codeload.github.com/sholladay/hapi-perm/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246300419,"owners_count":20755351,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["connection","database","db","hapi","plugin","rethinkdb","server"],"created_at":"2024-10-03T16:40:38.351Z","updated_at":"2025-03-30T09:28:02.805Z","avatar_url":"https://github.com/sholladay.png","language":"JavaScript","readme":"# hapi-perm [![Build status for hapi Perm](https://travis-ci.com/sholladay/hapi-perm.svg?branch=master \"Build Status\")](https://travis-ci.com/sholladay/hapi-perm \"Builds\")\n\n\u003e [RethinkDB](https://rethinkdb.com) storage for [hapi](https://hapijs.com/) web servers\n\nThis hapi plugin makes it easy to connect to a RethinkDB database and run queries against it, from route handlers and anywhere else you can access the `server` instance.\n\n## Why?\n\n - Stores data in [RethinkDB](https://rethinkdb.com).\n - Shares a database connection across routes.\n - Decorates the server to make queries easier.\n - Eliminates the repetitive use of `.run(conn)`.\n - Reconnects automatically on connection failures.\n\n## Install\n\n```sh\nnpm install hapi-perm\n```\n\n## Usage\n\nRegister the plugin on your server to connect to your database and make the `server.db(query)` helper function available.\n\n```js\nconst hapi = require('@hapi/hapi');\nconst perm = require('hapi-perm');\nconst r = require('rethinkdb');\n\nconst server = hapi.server();\n\nconst init = async () =\u003e {\n    await server.register({\n        plugin  : perm,\n        options : {\n            password : process.env.DB_PASSWORD\n        }\n    });\n    server.route({\n        method : 'GET',\n        path   : '/',\n        async handler(request) {\n            const { db } = request.server;\n            const tables = await db(r.tableList());\n            return tables;\n        }\n    });\n    await server.start();\n    console.log('Server ready:', server.info.uri);\n};\n\ninit();\n```\n\nIn the example above, `r` is the [RethinkDB library](https://rethinkdb.com/api/javascript/) used to construct queries. Behind the scenes, this plugin [connects](https://rethinkdb.com/api/javascript/connect/) to the database using the version of `r` installed by your application. This gives you full control over the connection options.\n\n## API\n\n### Plugin options\n\nType: `object`\n\nPassed directly to [`r.connect()`](https://rethinkdb.com/api/javascript/connect/) to configure the database connection. See the RethinkDB documentation for details.\n\n### Decorations\n\nFor convenience, this plugin adds the following API to the hapi server instance.\n\n#### server.db(query)\n\nReturns a `Promise` for the query's completion. Can be used instead of [`query.run(conn)`](https://rethinkdb.com/api/javascript/run/). Useful to avoid needing a reference to the database connection. This is available as `request.server.db(query)` inside of route handlers.\n\n## Contributing\n\nSee our [contributing guidelines](https://github.com/sholladay/hapi-perm/blob/master/CONTRIBUTING.md \"Guidelines for participating in this project\") for more details.\n\n1. [Fork it](https://github.com/sholladay/hapi-perm/fork).\n2. Make a feature branch: `git checkout -b my-new-feature`\n3. Commit your changes: `git commit -am 'Add some feature'`\n4. Push to the branch: `git push origin my-new-feature`\n5. [Submit a pull request](https://github.com/sholladay/hapi-perm/compare \"Submit code to this project for review\").\n\n## License\n\n[MPL-2.0](https://github.com/sholladay/hapi-perm/blob/master/LICENSE \"License for hapi-perm\") © [Seth Holladay](https://seth-holladay.com \"Author of hapi-perm\")\n\nGo make something, dang it.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsholladay%2Fhapi-perm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsholladay%2Fhapi-perm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsholladay%2Fhapi-perm/lists"}