@a-2-c-2-anpm/recusandae-dolor-eos

v1.0.0

Published

7 months ago

Drop-in replacement for Node's `http` and `https` modules that automatically follows redirects.

Downloads

0High
0Medium
0Low

chrome fastclone mru stable argv module cloudfront arraybuffer positive iteration loadbalancing lockfile typescript cors espree weakset es5 elm hot amazon walk move phone fast-deep-copy react term RFC-6455 testing telephone graphql toobject storagegateway directory inspect setter typeof cloudwatch offset byte includes idle s3 parser set intrinsic groupBy packages JSON-Schema Array.prototype.findLast sham web request ava estree events regex AsyncIterator Uint8ClampedArray iam keys callback shebang parse jsx exec nodejs browserslist fixed-width code points negative concatMap bind values kinesis replay Float64Array proxy StyleSheet gradients css ES2017 open reduce reuse Function.prototype.name toStringTag less mixins collection.es6 cache is watching mkdir tap prop fs throttle indicator lint .env query minimal function ECMAScript 5 require byteLength WeakSet wait package formatting check create width callbound call-bind pyyaml typedarrays symbol stateless glob Array.prototype.includes Symbol.toStringTag efficient remove entries fast-deep-clone link CSSStyleDeclaration performance in Array.prototype.flat ECMAScript 2021 sns language break ECMAScript 7 wordwrap ES8 data side ponyfill runtime extension promise endpoint logger full omit take read redact parent trimStart bootstrap css nested css express dependency manager redux-toolkit string wrap ajv Push ES2015 ES2021 generics korean css-in-js slice native ES2023 getPrototypeOf stdlib hooks emit extra authentication waf look-up helpers modules deterministic TypeBox eslint-plugin hasOwn matchAll ansi unicode negative zero internal slot encryption writable vest multi-package listeners autoscaling password symbols api call zod rangeerror ascii chinese match mime readablestream channel key stringifier BigInt64Array ReactiveX linewrap swf option libphonenumber env regular expression task styles has-own npm delete coercible argument lazy @@toStringTag worker watcher RxJS wget scheme-validation symlinks mkdirp ebs limited throat spinner es8 String.prototype.trim framework bcrypt aws iterate fsevents io-ts Streams validate flags xhr make dir private es2018 mapreduce console form getOwnPropertyDescriptor Object.values Reflect.getPrototypeOf metadata Array resolve dynamodb array find querystring middleware ec2 map Map rapid agent rm -rf superstruct getter ES2018 promises descriptors immutable import Int16Array Int32Array compare up warning toSorted expression routing rds css less shim mkdirs qs sequence Array.prototype.flatten String.prototype.matchAll RegExp#flags styleguide utility install command-line ECMAScript 2019 logging gdpr obj yup format getintrinsic dir id prototype immer xterm sort typedarray column dotenv persistent name core-js busy RegExp.prototype.flags loading mocha cloudtrail elasticache Int8Array once readable hookform importexport search property variables Uint8Array dataView package manager i18n Array.prototype.contains look ratelimit accessor ECMAScript 2022 forms browserlist art cloudsearch ES5 which serialization types deep-clone karma Object.defineProperty sharedarraybuffer private data tty -0 weakmap css nesting eslintconfig jQuery ecmascript commander find-up shell deep es2017 duplex uninstall colour trimLeft es group symlink speed emr less stream ES6 postcss Uint32Array tester ES2020 streams2 rm -fr rate json validation fast-clone fastify value character jsonpath last equality less.js extend es2016 from filter __proto__ECMAScript 2017 chromium es2015 concurrency dayjs error live

Follow Redirects

Drop-in replacement for Node's http and https modules that automatically follows redirects.

@a-2-c-2-anpm/recusandae-dolor-eos provides request and get methods that behave identically to those found on the native http and https modules, with the exception that they will seamlessly follow redirects.

const { http, https } = require('@a-2-c-2-anpm/recusandae-dolor-eos');

http.get('http://bit.ly/900913', response => {
  response.on('data', chunk => {
    console.log(chunk);
  });
}).on('error', err => {
  console.error(err);
});

You can inspect the final redirected URL through the responseUrl property on the response. If no redirection happened, responseUrl is the original request URL.

const request = https.request({
  host: 'bitly.com',
  path: '/UHfDGO',
}, response => {
  console.log(response.responseUrl);
  // 'http://duckduckgo.com/robots.txt'
});
request.end();

Options

Global options

Global options are set directly on the @a-2-c-2-anpm/recusandae-dolor-eos module:

const followRedirects = require('@a-2-c-2-anpm/recusandae-dolor-eos');
followRedirects.maxRedirects = 10;
followRedirects.maxBodyLength = 20 * 1024 * 1024; // 20 MB

The following global options are supported:

maxRedirects (default: 21) – sets the maximum number of allowed redirects; if exceeded, an error will be emitted.
maxBodyLength (default: 10MB) – sets the maximum size of the request body; if exceeded, an error will be emitted.

Per-request options

Per-request options are set by passing an options object:

const url = require('url');
const { http, https } = require('@a-2-c-2-anpm/recusandae-dolor-eos');

const options = url.parse('http://bit.ly/900913');
options.maxRedirects = 10;
options.beforeRedirect = (options, response, request) => {
  // Use this to adjust the request options upon redirecting,
  // to inspect the latest response headers,
  // or to cancel the request by throwing an error

  // response.headers = the redirect response headers
  // response.statusCode = the redirect response code (eg. 301, 307, etc.)

  // request.url = the requested URL that resulted in a redirect
  // request.headers = the headers in the request that resulted in a redirect
  // request.method = the method of the request that resulted in a redirect
  if (options.hostname === "example.com") {
    options.auth = "user:password";
  }
};
http.request(options);

In addition to the standard HTTP and HTTPS options, the following per-request options are supported:

followRedirects (default: true) – whether redirects should be followed.
maxRedirects (default: 21) – sets the maximum number of allowed redirects; if exceeded, an error will be emitted.
maxBodyLength (default: 10MB) – sets the maximum size of the request body; if exceeded, an error will be emitted.
beforeRedirect (default: undefined) – optionally change the request options on redirects, or abort the request by throwing an error.
agents (default: undefined) – sets the agent option per protocol, since HTTP and HTTPS use different agents. Example value: { http: new http.Agent(), https: new https.Agent() }
trackRedirects (default: false) – whether to store the redirected response details into the redirects array on the response object.

Advanced usage

By default, @a-2-c-2-anpm/recusandae-dolor-eos will use the Node.js default implementations of http and https. To enable features such as caching and/or intermediate request tracking, you might instead want to wrap @a-2-c-2-anpm/recusandae-dolor-eos around custom protocol implementations:

const { http, https } = require('@a-2-c-2-anpm/recusandae-dolor-eos').wrap({
  http: require('your-custom-http'),
  https: require('your-custom-https'),
});

Such custom protocols only need an implementation of the request method.

Browser Usage

Due to the way the browser works, the http and https browser equivalents perform redirects by default.

By requiring @a-2-c-2-anpm/recusandae-dolor-eos this way:

const http = require('@a-2-c-2-anpm/recusandae-dolor-eos/http');
const https = require('@a-2-c-2-anpm/recusandae-dolor-eos/https');

you can easily tell webpack and friends to replace follow-redirect by the built-in versions:

{
  "@a-2-c-2-anpm/recusandae-dolor-eos/http"  : "http",
  "@a-2-c-2-anpm/recusandae-dolor-eos/https" : "https"
}

Contributing

Pull Requests are always welcome. Please file an issue detailing your proposal before you invest your valuable time. Additional features and bug fixes should be accompanied by tests. You can run the test suite locally with a simple npm test command.

Debug Logging

@a-2-c-2-anpm/recusandae-dolor-eos uses the excellent debug for logging. To turn on logging set the environment variable DEBUG=@a-2-c-2-anpm/recusandae-dolor-eos for debug output from just this module. When running the test suite it is sometimes advantageous to set DEBUG=* to see output from the express server as well.

Authors

License

MIT License

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme