Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Fetching latest commit…

Cannot retrieve the latest commit at this time

..
Failed to load latest commit information.
lib
public
uploads
README.md
favicon.png
index.js
package.json

README.md

http

provides an HTTP API

API

properties

methods

properties

provides an HTTP API

  • id

    • type : any
  • port

    • type : number

    • default : 8888

    • description : the port to listen on

  • host

    • type : string

    • default : 0.0.0.0

    • description : the host interface to listen on

  • root

    • type : string

    • default : /Users/macbookpro/dev/big/big/public

methods

http.listen(options, callback)

starts a listening http server

  • options

    • type : object

    • properties

      • port

        • type : number

        • default : 8888

        • description : the port to listen on

      • host

        • type : string

        • default : 0.0.0.0

        • description : the host interface to listen on

      • root

        • type : string

        • default : /Users/macbookpro/dev/big/big/public

      • enableUploads

        • type : boolean

        • default : true

  • callback

    • description : the callback executed after server listen

    • type : function

    • required : false

http.start(options, callback)

starts a listening http server

  • options

    • type : object

    • properties

      • port

        • type : number

        • default : 8888

        • description : the port to listen on

      • host

        • type : string

        • default : 0.0.0.0

        • description : the host interface to listen on

      • root

        • type : string

        • default : /Users/macbookpro/dev/big/big/public

      • enableUploads

        • type : boolean

        • default : true

  • callback

    • description : the callback executed after server listen

    • type : function

    • required : false

http.request(options)

makes outgoing http client requests

  • options

    • type : object

    • properties

      • uri

        • description : the uri to be requested

        • type : string

        • required : true

      • qs

        • description : querystring values appended to the uri

        • type : object

        • required : false

      • method

        • description : the HTTP method to use

        • type : string

        • enum

          • 0 : GET

          • 1 : HEAD

          • 2 : POST

          • 3 : PUT

          • 4 : DELETE

          • 5 : TRACE

          • 6 : OPTIONS

          • 7 : CONNECT

          • 8 : PATCH

      • headers

        • description : the http headers for the request

        • type : object

        • required : false

      • body

        • description : the raw body for POST and PUT requests

        • required : false

      • form

        • description : form data in the request body

        • type : object

        • required : false

      • json

        • description : JSON data in the request body

        • type : any

        • required : false

      • multipart

        • description : data in a multi-part request

        • type : array

        • required : false

      • maxRedirects

        • description : maximum number of redirects to follow

        • type : number

        • required : false

        • default : 10

      • encoding

        • description : set the text encoding of the request body

        • type : string

        • required : false

      • timeout

        • description : how long to wait (in ms) before the request times out

        • type : number

        • required : false

dependencies

README auto-generated with docs

Something went wrong with that request. Please try again.