x-clacks-middleware v1.0.1

X-Clacks-Middleware

Table of Contents

• Introduction
  • Features
• Installation + Usage

Introduction

X-Clacks-Middleware is an Express.js middleware package that adds the x-clacks-overhead header to your server responses. Simply register this middleware in your Express server, and add your site to the registry of those that "carry the signal"!

What is X-Clacks-Overhead?

From the X-Clacks-Overhead website: "X-Clacks-Overhead is a non-standardised HTTP header based upon the fictional work of the late, great, Sir Terry Pratchett.

In Terry Pratchett's science-fantasy Discworld series, "The Clacks" is a network infrastructure of Semaphore Towers, that operate in a similar fashion to telegraph - named "Clacks" because of the clicking sound the system makes as signals send.

In Sir Terry's novel "Going Postal"...the inventor of the Clacks...lost his only son...and in order to keep the memory of his son alive, he transmitted his son's name as a special operational signal through the Clacks to forever preserve his memory."

Features

!screenshot

• zero dependencies
• plug n' play
• randomizes the header values with one of any number of names

Installation and Usage

Install the package in your repository:

npm i x-clacks-middleware

Register the middleware in your Express app. The default header value is 'Terry Pratchett'. You may elect to use the middleware option names to add one or multiple names to commemorate.

app.use(setXClacksOverheadHeader({ 
    names: [
        "Yukio Mishima", 
        "Hermann Hesse", 
        "John Conway"
        ] 
    })
);

Options is an object with a names property, an Array of one or more strings. The header will randomly select one of the names for each response (assuming you've provided more than one name, of course) and prepend it with the GNU prefix, per the x-clacks-overhead standard.