Git Product home page Git Product logo

signalk-plugin-base's Introduction

SignalK-Plugin-Base

Javascript base class for developing plugins for the SignalK Node Server

Features

Using SignalKPlugin has the following advantages over developing a plugin from scratch:

  • Automatically manages unsubscribing from streams when the subscribeVal() method is used
  • Automatically initializes configuration options if the default value is specified
  • Sets up commonly used properties, such as this.dataDir, this.options, this.app, etc.
  • Simplifies calls to the Node Server's API by hiding complex API calls in local methods. Learning the public methods available on this class is usually all one needs to develop a complete plugin

API Documentation

See the complete documentation for the SignalKPlugin class here

Yoeman integration

For even faster development, be sure to see the Yoeman generator that utilizes this class.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.