ts-framework-versioning

A minimalistic framework for typescript based applications, with async/await and decorators support.

This plugin extends the Server for handling safe versioning using Headers.

# Install using yarn
yarn add git:https://gitlab.devnup.com/npm/ts-framework-versioning.git#master

# Install using NPM
npm install --save git:https://gitlab.devnup.com/npm/ts-framework-versioning.git#master

Getting Started (TS-Framework)

Add the module as a Server middleware overriding the router registration method.

import Server from 'ts-framework';
import { Versioning } from 'ts-framework-versioning';

class MyServer extends Server {
  constructor() {
    super({
      port: process.env.PORT as any || 3333,
      routes: {
        get: { '/': (req, res) => res.success({ test: 'ok' }) }
      },
    })
  }

  public register() {
    // Initialize the version middleware
    this.app.use(Versioning.middleware({
      current: '1.2.3', // Required field
      minimum: '1.2.0', // Optional field, will ensure minimum version for all requests
      recommended: '1.2.1', // Optional field, will set a recommended version header
    }));

    // Continue with the router initialization
    return super.register();
  }
}

Getting Started (Express)

This module is also compatible with an Express server.

const express = require('express');
const { Versioning } = require('ts-framework-versioning');

const app = express();

app.use(Versioning.middleware({
  current: '1.2.3', // Required field
  minimum: '1.2.0', // Optional field, will ensure minimum version for all requests
  recommended: '1.2.1', // Optional field, will set a recommended version header
}));

app.listen(3000, () => console.log('Server listening on port: 3000'));

Documentation

new Versioning(options: VersioningOptions)

options.current (Required): The current version, should be a valid Semver tag.
options.recommended: The recommended version, should be a valid Semver tag.
options.minimum: The minimum version, should be a valid Semver tag.
options.header: The header for specifing the current API version, defaults to X-API-Version.
options.requestedHeader: The header for specifing the requested API version, defaults to X-API-Requested-Version.
options.recommendedHeader: The header for specifing the recommended API version, defaults to X-API-Recommended-Version.

License