pigalle.registries.thirdparties
A registry to use third party libraries with the Pigalle framework.
🍎 Warning ! Work in progress...
Table of Contents
- Synopsis
- Usage
- Installation
- API Reference
- Tests
- Build
- Compatibility
- Issues
- Contributing
- Credits
- History
- License
Synopsis
A registry to use third party libraries with the Pigalle framework.
Usage
const {ThirdPartiesRegistry} = require('@pigalle/registries.thirdparties')
const {ThirdPartyPlugin} = require('@pigalle/plugins.thirdparty')
// Create a new registry to store third parties.
const registry = ThirdPartiesRegistry.factory()
// Add express.js to the registry
registry.set(ThirdPartyPlugin.factory('express'))
// Add restify to the registry
registry.set('http-backend', ThirdPartyPlugin.factory('restify'))
// Another way to add restify to registry
registry.set('restify')
// Another way ;-)
registry.set('http-backend', 'restify')Installation
npm install @pigalle/registries.thirdparties
API Reference
Please refer to API documentation.
Tests
Run unit tests
npm test
Build
Build documentation
Be careful! Documentation (README and API) is generated using templates. Please only modify documentation from related templates.
Then you can build documentation using the following command:
npm run docs
or:
gulp docs
Compatibility
Node
Tested using Node 9.5.0.
Browser
Untested at this time.
Issues
Feel free to submit issues and enhancement requests.
Contributing
Please refer to project's style guidelines and guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull request so that we can review your changes
NOTE: Be sure to merge the latest from "upstream" before making a pull request!
Credits
Thanks to the developers of the very useful dependencies...
History
Please refer to the changelog file.
License
Copyright (c) 2018 SAS 9 Février
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.