jec-commons-node v1.0.9
JEC Node.js Commons Project
JEC Node.js Commons is a JavaScript Enterprise Container project focused on all aspects of reusable components that are used by JEC implementations built over Node.js.
Requirements
JEC Node.js Commons needs the following system parameters in order to work correctly:
- Node 6+
- npm 3+
- TypeScript 2+
Installation
Set up the JEC Node.js Commons module with:
$ npm install jec-commons-node --save
Using Components
All JEC Node.js Commons components have to be imported with the ES6 syntax:
import { FilePropertiesBuilder } from "jec-commons-node";
const BUILDER:FilePropertiesBuilder = new FilePropertiesBuilder();
For a complete list of available components, please refer to the API Reference documentation.
Running Tests
To execute all unit tests, use:
$ grunt test
API Reference
The API Reference documentation is not included into the JEC Node.js Commons node module. To build the API reference documentation, use:
$ grunt doc
Documentation will be generated in the docs/api-reference
repository.
The online version of the API reference documentation is available at: http://jecproject.org/docs/jec-commons-node/api/
The documentation generator is TypeDoc
Update Release Notes
Current stable release: 1.0.9
For a complete listing of release notes for all JEC Node.js Commons update releases, see the CHANGELOG file.
License
This JEC Node.js Commons Project is licensed under Apache 2.0. Full license text is available in LICENSE.
Copyright 2016-2018 Pascal ECHEMANN.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.