boxfishcurl

Curl library for the boxfish ads platform

Usage no npm install needed!

<script type="module">
  import boxfishcurl from 'https://cdn.skypack.dev/boxfishcurl';
</script>

README

BoxfishCurl.js

Installation

npm install boxfishcurl

Using simple Request

Usage

// GET
curl.get('http://google.com').then([Function], [Function]);
// POST
curl.post('http://your-post-url', params).then([Function], [Function]);
// PUT
curl.put('http://your-PUT-url', params).then([Function], [Function]);
// DELETE
curl.delete('http://your-DELETE-url', params).then([Function], [Function]);

default properties

you can set any request options here, including any header you may need.

curl.init({ headers: { 'Content-Type' : 'application/json' } });

Using HTTP and HTTPS modules

Usage

Param type Required Default
host string true -
path string true -
port string 80
method string 'GET'
headers object -
data string 'application/x-www-form-urlencoded'
curl
    .req({
    host    : 'boxfish.com',
    path    : '/',
    headers : { 'Content-Type': 'application/json' },
    method  : 'POST',
    data    : {
        field       : 'this can be any JSON',
        used        : 'this will be sent in the request body',
        required    : false
    }
  }).then(function(response) {
    // you got your data back
  }, function(err) {
    // something went wrong
  });

Run test

npm test