Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@cloudflare/util-http

Package Overview
Dependencies
Maintainers
27
Versions
47
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@cloudflare/util-http

Cloudflare HTTP Util

  • 2.0.16
  • latest
  • npm
  • Socket score

Version published
Maintainers
27
Created
Source

cf-util-http

Cloudflare HTTP Util

This utility library is a simple interface that hides away the client-side http implementation being used so that it can easily be swapped out for something else.

Installation

$ npm install cf-util-http

Usage

import * as http from 'cf-util-http';

http.beforeSend(opts => {
  opts.url = '/api/v4' + opts.url;
});

http.post('/posts', {
  body: {
    title: 'A New Post',
    content: 'Contents of the new post.'
  }
}, (err, res) => {
  if (err) {
    console.log(err.body); // > { errors: [{ message: 'Error!' }] }
  } else {
    console.log(res.body); // > { result: { id: 1, title: 'A New Post', content: 'Contents of the new post.' } }
  }
});

API

http.request(method, url, [opts], [callback])

Perform an HTTP request.

const abortRequest = http.request('POST', '/posts', {
  headers: {...},
  parameters: {...},
  body: {...}
}, callback);

abortRequest();

Parameters:

NameTypeDescription
methodStringRequired. The HTTP method type for the request.
urlStringRequired. The url to make the request.
optsObjectOptional. Options for the request.
opts.parametersObjectOptional. Parameters to be serialized into the url.
opts.headersObjectOptional. Headers to send with the request.
opts.bodyObjectOptional. The body of the request.
opts.skipBodyTransformBooleanOptional. Prevents opts.body from being converted to JSON.
callbackFunctionCallback to call when request is complete.

Returns:

http.request will return an abort function that you can call to stop the request from being made.

callback:

The callback will receive two arguments: err and res which will both have the following shape (if they are not null):

{
  headers: {...},
  status: 200,
  body: {...}
  text: '...'
}

http.[get/post/put/patch/del]

These are all shorthands to http.request that don't require passing a method.

http.beforeSend(callback)

Modify a request before it is sent. This can be useful for authentication or other middleware.

callback will be called with a single argument opts that you can mutate before a request will be created. opts will have the following shape:

{
  method: 'POST',
  url: '/posts',

  // Headers to be sent along with the request
  headers: {
    Accept: 'application/json'
  },

  // Parameters to be serialized as `?page=1&limit=20` and appended to the url
  parameters: {
    page: 1,
    limit: 20
  },

  // Body of the request being sent
  body: {
    title: 'A New Post',
    content: 'Contents of the new post.'
  }
}

Note that headers, parameters, and body may not exist depending on the request being made.

FAQs

Package last updated on 14 Feb 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc