@mangar2/httpservice v2.1.0

Abstract

Provides simple http/https client and server classes

Contents

• Meta
• Global Functions
  • echo
  • run
• Class HTTPClient
  • Parameters
  • Members
  • Methods
    • close
    • getRequest
    • post
    • put
    • send
    • sendv2
    • setConnection
• Class HTTPSClient
  • Parameters
  • Methods
    • close
    • getRequest
    • post
    • put
    • send
    • sendv2
• Class HTTPSServer
  • Parameters
  • Members
  • Methods
    • close
    • listen
    • on
• Class HTTPServer
  • Parameters
  • Members
  • Methods
    • close
    • listen
    • on

Meta

Callback definitions

HTTPGetCallback

Callback for HTTP ( S ) GET requests

HTTPGetCallback Parameters

HTTPCallback

Callback for HTTP ( S ) put , post , patch , delete , listen , or closed requests

HTTPCallback Parameters

Global functions

echo

async echo (method, header, payload, path, res)

Handles a post request

echo Parameters

run

run ()

Starts the server

Class HTTPClient

new HTTPClient(host, port, type)

Class simplifying access to the node http service for http clients

Example

const client = new HTTPClient('myhost', 10000);
client.sendv2({ path: 'info/getdata/1', method: 'GET' })
client.post({ path: 'postdata/1', payload={info: 'hello world')}, type='json' })
client.get('info/getdata/1')

HTTPClient Parameters

HTTPClient Members

HTTPClient Methods

close

close () => {promise}

Aborts all open requests

close returns

getRequest

getRequest (path, headers) => {Promise<{statusCode, headers, payload}

Sends a get request

getRequest Parameters

getRequest returns

post

post (sendOptions, type) => {Promise<{statusCode, headers, payload}

Sends a post request

post Parameters

sendOptions properties

post returns

put

put (sendOptions, type) => {Promise<{statusCode, headers, payload}

Sends a put request

put Parameters

sendOptions properties

put returns

send

send (path, method, payload, headers) => {Promise<{statusCode, headers, payload}

Sends data . A payload of type "object" is automatically stringified , a string is not

send Parameters

send returns

sendv2

sendv2 (sendOptions, type) => {Promise<{statusCode, headers, payload}

Sends data . Adds a content-type element to the header and stringifies the boy based on the type

sendv2 Parameters

sendOptions properties

sendv2 returns

setConnection

setConnection (host, port)

Sets host name and port number

setConnection Parameters

Class HTTPSClient

new HTTPSClient(host, port)

Class simplifying access to the node http service for http clients

Example

client.sendv2({ path: 'info/getdata/1', method: 'GET' })
client.post({ path: 'postdata/1', payload={info: 'hello world')}, type='json' })
client.get('info/getdata/1')

HTTPSClient Parameters

HTTPSClient Methods

close

close () => {promise}

Aborts all open requests

close returns

getRequest

getRequest (path, headers) => {Promise<{statusCode, headers, payload}

Sends a get request

getRequest Parameters

getRequest returns

post

post (sendOptions, type) => {Promise<{statusCode, headers, payload}

Sends a post request

post Parameters

sendOptions properties

post returns

put

put (sendOptions, type) => {Promise<{statusCode, headers, payload}

Sends a put request

put Parameters

sendOptions properties

put returns

send

send (path, method, payload, headers) => {Promise<{statusCode, headers, payload}

Sends data . A payload of type "object" is automatically stringified , a string is not

send Parameters

send returns

sendv2

sendv2 (sendOptions, type) => {Promise<{statusCode, headers, payload}

Sends data . Adds a content-type element to the header and stringifies the boy based on the type

sendv2 Parameters

sendOptions properties

sendv2 returns

Class HTTPSServer

new HTTPSServer(port)

Creates a http server listening to a certain port for simplifying access to the node http service Register your callbacks according to the http functions you need .

Example

const server = new HTTPSServer(10000)
server.on('GET', (URLSearchParam, headers, path, res) => console.log(path))
const httpsOptions = {
  key: fs.readFileSync('key.pem'),
  cert: fs.readFileSync('cert.pem')
}
server.listen(httpsOptions)
server.close()

HTTPSServer Parameters

HTTPSServer Members

HTTPSServer Methods

close

close () => {promise}

Stops the server from accepting new connections and closes existing connections . Calls the callback "close" , once the server is closed .

close returns

listen

listen (options)

Creates a https server listening

listen Parameters

on

on (event, callback)

Sets a callback

on Parameters

Class HTTPServer

new HTTPServer(port)

Creates a http server listening to a certain port for simplifying access to the node http service Register your callbacks according to the http functions you need .

Example

const server = new HTTPServer(10000)
server.on('GET', (URLSearchParam, headers, path, res) => console.log(path))
server.listen()
server.close()

HTTPServer Parameters

HTTPServer Members

HTTPServer Methods

close

close () => {promise}

Stops the server from accepting new connections and closes existing connections . Calls the callback "close" , once the server is closed .

close returns

listen

listen ()

Creates a http server listening

on

on (event, callback)

Sets a callback

on Parameters