README.md

curly-express

curly-express print all received requests as curls.

🇺🇦 Help Ukraine

I woke up on my 26th birthday at 5 am from the blows of russian missiles. They attacked the city of Kyiv, where I live, as well as the cities in which my family and friends live. Now my country is a war zone.

We fight for democratic values, freedom, for our future! Once again Ukrainians have to stand against evil, terror, against genocide. The outcome of this war will determine what path human history is taking from now on.

💛💙 Help Ukraine! We need your support! There are dozen ways to help us, just do it!

Table of Contents

• curly-express
  • 🇺🇦 Help Ukraine
  • Table of Contents
  • Requirements
  • Installation
  • Usage
    • Default configuration
    • Advanced usage
      • Customize logger
      • Attach to request
  • Contribute

Requirements

To use library you need to have node and npm installed in your machine:

• node >=10
• npm >=6

Package is continuously tested on darwin, linux and win32 platforms. All active and maintenance LTS node releases are supported.

Installation

To install the library run the following command

  npm i --save curly-express

Usage

This package can be used as middleware. Note that it must be placed after body-parser in order to receive the request body.

Default configuration

In the default configuration, the middleware will print cURL to stdout:

import curl             from 'curly-express';
import express          from 'express';

const app = express();

app.use(bodyParser.json());
app.use(curl);
app.use(router);

Advanced usage

You can customize some stuff by importing the factory method:

Customize logger

You can pass your own logger as an optional parameter:

import { cURL }  from 'curly-express';

const curl =  cURL({
    log : console.log
});

app.use(curl);

Attach to request

If you need curl in further middlewares, you can do it with optional argument attach:

import { cURL }  from 'curly-express';

const curl =  cURL({
    attach : true
});

app.use(curl); // check req._curl

it will add curl to _curl property of the request object. If you want to change the property key, use:

const curl =  cURL({
    attach : '_curl_custom_key'
});

Contribute

Make the changes to the code and tests. Then commit to your branch. Be sure to follow the commit message conventions. Read Contributing Guidelines for details.