Read Write Serve Plugin SDK

Develop high quality RWSERVE plugins

Motivation

Any RWSERVE plugin that you write will need a few basic tools in order to operate nicely within the server environment. Use of these is not mandatory. You are free to develop your plugin with your own set of helper functions.

Contents

• log is a module for logging actions in a way that is compatible with the server's standard logging function.
• SC is an enum for HTTP response status codes .
• expect is a function for explicit argument type checking used in design by contract principles. It acts like a soft assertion, logging unmet expectations, but allowing your code to continue as best it can.

Download

The SDK is available from NPM . Before proceeding, you should already have Node.js and RWSERVE configured and tested.

This module should be installed on your web server in a well-defined place, so that it can be shared by all RWSERVE plugins. The standard location is /srv/rwserve-plugins .

Usage

Use require within your codebase to access the SDK. Here's a simple demonstration of a plugin that uses the SDK:

Prerequisites

This is a plugin for the Read Write Tools HTTP/2 Server, which works on Linux platforms.

License

The rwserve-plugin-sdk is licensed under the MIT License.

Availability