Package Exports

curl-wrap
curl-wrap/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (curl-wrap) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

curl-wrap

Nodejs library that wraps curl command line

Install

npm install curl-wrap
# OR
yarn add curl-wrap

Usage

const {Curl} = require('curl-wrap');

const response = await Curl.get('https://www.google.com');
console.log(response.body);
console.log(response.statusCode);

Creating a Curl Instance

const response = await Curl.url('https://www.example.com')
    .post()
    .header('Accept', 'application/json')
    .followRedirect(true)
    .timeout(30);

// you can also use
const curl = new Curl();
curl.url('https://www.example.com');
curl.post();
curl.header('Accept', 'application/json');
curl.followRedirect(true);
curl.timeout(30);
const res = await curl;

Setting Headers

curl.header('Content-Type', 'application/json');
curl.headers({
    'User-Agent': 'curl-wrap/1.0',
    'Accept': 'application/json'
});

// clear all headers
curl.clearHeaders();

Setting Cookies

curl.cookie('sessionId', 'abc123');
curl.cookies({
    'sessionId': 'abc123',
    'userId': 'user456'
});

// enable in memory cookie storage for all requests
curl.globalCookies();

// use a cookie file to store and read cookies
curl.cookieFile('cookies.json');

Setting Proxy

curl.proxy('http://proxy.example.com:8080');
curl.proxy({
    address: 'proxy.example.com',
    port: 8080,
    type: 'http',
    auth: {
        username: 'user',
        password: 'pass'
    }
});

Authentication

curl.httpAuth('username', 'password');
curl.bearerToken('your-token');
curl.apiToken('your-api-token');

Impersonating a Browser

NOTE: it will use curl-impersonate if it is in PATH.
See: https://github.com/lexiforest/curl-impersonate

curl.impersonate('chrome');
curl.impersonate('chromeMobile');
curl.impersonate('firefox');
curl.impersonate('safari');
curl.impersonate('safariMobile');
curl.impersonate('edge');

// Or create a new instance with impersonation
const chromeCurl = Curl.impersonate('chrome');

Setting Request Method

curl.method('POST');
curl.get();
curl.post();
curl.put();

Setting Request Body

curl.body({key: 'value'});
curl.body('any data');
curl.json({key: 'value'});

Setting POST/PUT Fields

curl.field('key', 'value');
curl.fields({
    key1: value1,
    key2: value2,
});

Setting Query Parameters

curl.query('search', 'term');
curl.query({
    search: 'term',
    page: 1
});

Setting Timeout

curl.timeout(30); // in seconds
curl.timeoutMs(30000); // in milliseconds

Handling Responses

try {
    const response = await curl;
    console.log(response.body);
    console.log(response.statusCode);
}
catch (error) {
    console.error(error);
}

Verbose Output

curl.verbose(true);
const response = await curl;
console.log(response.stderr);

Buffer Response

curl.asBuffer();
const response = await curl;
console.log(response.body); // Buffer object instead of string

Export as Curl Command

const curl = Curl.url('https://api.example.com')
    .post()
    .header('Content-Type', 'application/json')
    .body({key: 'value'});

const curlCommand = await curl.exportAsCurl();
console.log(curlCommand);
// Output:
// curl 'https://api.example.com' \
//   --request POST \
//   --header 'content-type: application/json' \
//   --data-raw '{"key":"value"}'

Import from Curl Command

const curlCommand = `curl 'https://api.example.com' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer token123' \
  --cookie 'session=abc123; user=john' \
  --data-raw '{"name":"John","age":30}'`;

const curl = Curl.fromCurl(curlCommand);
const response = await curl;

Cloning Requests

const baseCurl = Curl.url('https://api.example.com')
    .header('Authorization', 'Bearer token123')
    .header('Content-Type', 'application/json');

// Clone and modify for different endpoints
const getUserCurl = baseCurl.clone()
    .url('https://api.example.com/user')
    .get();
const createUserCurl = baseCurl.clone()
    .url('https://api.example.com/user')
    .post()
    .body({name: 'John'});

// Both requests share the same headers but have different URLs and methods
const userResponse = await getUserCurl;
const createResponse = await createUserCurl;

Method Chaining

Curl.url('https://www.example.com')
    .method('GET')
    .header('Accept', 'application/json')
    .followRedirect(true)
    .maxRedirects(5)
    .timeout(30)
    .then(response => {
        console.log(response.body);
    })
    .catch(error => {
        console.error(error);
    })
    .finally(() => {
        console.log('Request completed');
    });