superagent-proxy.d.ts 849 B

123456789101112131415161718192021222324252627282930
  1. import { SuperAgent, SuperAgentRequest } from 'superagent';
  2. /**
  3. * Adds a `.proxy(uri)` function to the "superagent" module's Request class.
  4. *
  5. * ``` js
  6. * var request = require('superagent');
  7. * require('superagent-proxy')(request);
  8. *
  9. * request
  10. * .get(uri)
  11. * .proxy(uri)
  12. * .end(fn);
  13. * ```
  14. *
  15. * Or, you can pass in a `superagent.Request` instance, and it's like calling the
  16. * `.proxy(uri)` function on it, but without extending the prototype:
  17. *
  18. * ``` js
  19. * var request = require('superagent');
  20. * var proxy = require('superagent-proxy');
  21. *
  22. * proxy(request.get(uri), uri).end(fn);
  23. * ```
  24. *
  25. * @param {Object} superagent The `superagent` exports object
  26. * @api public
  27. */
  28. export default function setup(superagent: any, uri?: string): SuperAgent<SuperAgentRequest> & {
  29. proxy: (uri?: string) => SuperAgent<SuperAgentRequest>;
  30. };