npm

Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript. Learn more »

@pigalle/core.base.klass

0.6.3 • Public • Published

pigalle.core.base.klass

Base class used by the Pigalle framework.


Warning ! Work in progress...

JavaScript Style Guide Latest NPM release NPM Downloads TravisCI Build Status Test Coverage Code Climate License Dependencies Dev Dependencies Greenkeeper badge

Table of Contents

Synopsis

Base class used by the Pigalle framework.

Usage

 
const {PigalleBaseClass} = require('pigalle.core.base.class')
 
// A derived class of {PigalleBaseClass}.
class MyPigalleExtension extends PigalleBaseClass {
  
  constructor (...args) {
    super(...args)
  }
  
  // A simple method
  hello (name) {
    return `Hello ${name}!`
  }
}
  
// Create a new instance of {MyPigalleExtension}
const instance = MyPigalleExtension.factory()
  
instance.hasMethod('hello') // returns true
instance.hasMethod('missing') // returns false
MyPigalleExtension.className() // return 'MyPigalleExtension'
 
 

Installation

npm install @pigalle/core.base.klass

API Reference

Please refer to API documentation hosted by Read the Docs.

Tests

Run unit tests

npm test

Build

Documentation

Generate README

Be careful! :

Generate API documentation

The API documentation is automatically generated using Read the Docs.

Compatibility

Node

Browser

N/A

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.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. 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!

History

Please refer to the changelog file.

License

The MIT License

Copyright (c) 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.

Keywords

none

install

npm i @pigalle/core.base.klass

Downloadsweekly downloads

7

version

0.6.3

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability