Home Reference Source Test

Function

Static Public Summary
public

Creates a redirection express middleware

public

Start a redirection service

Static Public

public createRedirectMiddleware(options: Object): Function source

import {createRedirectMiddleware} from 'nodejs-redirect/src/createRedirectMiddleware.js'

Creates a redirection express middleware

Params:

NameTypeAttributeDescription
options Object

Options object.

options.to string

URl to redirect requests

options.chain boolean
  • optional
  • default: false

Will chain the request path to the redirect url.

Return:

Function

Express middleware function

public startRedirectService(options: Object) source

import {startRedirectService} from 'nodejs-redirect/src/startRedirectService.js'

Start a redirection service

Params:

NameTypeAttributeDescription
options Object

Options object.

options.to String

URl to redirect requests.

options.chain Boolean
  • optional
  • default: false

Will chain the request path to the redirect url.

options.port Number
  • optional
  • default: 3000

Port to run the service.