Skip to content

Alinex Core

core icon

The core module is a base for all of my Alinex modules. It contains three parts:

  1. Some helper to manage alinex modules by myself and keep them in-sync like setup new modules or update the documentation theme.
  2. Basic functions needed in alinex modules. This is a collection of small functions which are not covered in separate modules.
  3. Standards definition for Alinex modules as documentation.

It's common methods which are necessary in nearly all of my packages at the moment contains:

  • exit - handler for process exits
  • logo - a method to present ASCII art command line logos

Installation

To include this in your module install it:

npm install @alinex/core --save

Now only include it in your code and call it's methods. Or use the bin/... commands to use the Alinex environment helpers.

Statistics

The following statistics will give you a better understanding about it's complexity. The documentation has 26 pages (in A4 PDF format) and contains 30781 characters. And this package has 180 lines of code.

The latest version in the repository is Version 1.7.1. It has a size of 236,68KiB in 35 files. The development contains 17 packages (resolved) and 0 of it are from the Alinex project.

Download Documentation

If you want to have an offline access to the documentation, feel free to download the 26 pages PDF Documentation.

License

Alinex Core

Copyright 2016, 2019 - 2020 Alexander Schilling (https://gitlab.com/alinex/node-core)

Apache License, Version 2.0

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.