2.1.10 • Published 5 years ago

breakrequest v2.1.10

Weekly downloads
-
License
ISC
Repository
github
Last release
5 years ago

Break - v2.1 - Module

  • All bug patched.
  • Older versions no longer work
npm install breakrequest
npm install w3c-xmlhttprequest

Why you need to use "Break" ?

Break allows you to easily create any type of request to a server. But not only ! It automatically corrects the urls in case of problems and will come to define itself automatically: the url, the type of request and the type of send. Break also allows response backup as well as a responseJSON if possible. Finally, it automatically detects and manages any type of error and sends it back to you in case of problems!

  • We can say that Break fully manages your requests and any type of response from the server.

What is new in v2.1?

  • You can now get and set the headers
  • You can set the responseType
  • Two new system of correction in the URL look at the [API]
  • Request become BreakRequest
  • break.min.js is here !
  • Support port (listen) finish !
  • New Command: element.correctURL, element.listen
  • Bug setting
  • Readme update
  • API update
  • Module added (beta)

Support - XMLHttpRequest:

  • SetRequestHeader
  • getAllResponseHeader
  • Send
  • POST
  • GET
  • PORT

Support - WebSocket:

  • CONNECTION
  • SEND
  • MESSAGES
  • PORT

Support - EventSource:

  • CONNECTION
  • MESSAGES
  • PORT

Support- All:

  • Mesage
  • Open
  • Close
  • Error

Command:

  • element.type
  • element.json
  • element.url
  • element.response
  • element.send
  • element.connected
  • element.error
  • element.correctURL
  • element.listen
  • element.method
  • element.responseType
  • element.writeHead
  • element.headerMap
  • element.request
  • element.loop
  • element.ext

How to use:

  • You need to install XMLHttpRequest with:
npm install xmlhttprequest
  • Install my module with:
var mod = require('breakrequest');
var XMLHttpRequest = require('w3c-xmlhttprequest').XMLHttpRequest;

Exemple:

var mod = require('breakrequest');
var XMLHttpRequest = require('w3c-xmlhttprequest').XMLHttpRequest;
var req = new mod.BreakRequest("https://echo.websocket.org"); //BREAK AUTOMATICALLY SET THE URL ON 'wss://echo.websocket.org'
req.on('message', function(msg){
  console.log(msg.data);
});
req.on('error', function(e){
  console.error(e);
});
req.on('close', function(e){
  console.warn("Server closed ! : "+e);
});
req.on('open', function(response){
	if(response){
		console.info(response); //JSON
	}
	req.send('Connection effectued');
});
//req.listen(3000);
req.connect();

USE:

Define the variable without launching the query:

var request = new BreakRequest("url");
request.on(type, function(){}); //SEE 'https://github.com/YoannCHB/Break#support--all'

How to know if the connection is ok ?

request.on('open', function(response){
console.log(response);
});

Send:

request.on('open', function(response){
  request.send("I m connected");
});

Launch the connection:

request.connect("new url || auto setup to the default url");

Extensions:

req.type //RETRUN THE TYPE OF REQUEST USED
req.json //RETURN THE RESPONSE IN JSON 
req.url //RETURN THE URL
req.response //RETURN THE RESPONSE
req.send //SEND MATHOD OR POST METHOD
req.connected //RETURN THE STATUS
req.error //RETURN THE STATUS
req.correctURL //RETURN CORRIGED URL
req.listen //FUNCTION TO SET A PORT (example: https://localhost:3000)
req.method //ALWAYS RETURN 'GET'
req.responseType //SET THE RESPONSE TYPE
req.headerMap //GET ALL THE HEADERS
req.writeHead //SET THE HEADERS
req.ext //SET THE EXTENSION - FOR EXAMPLE "www.google.com" --> req.ext('com');
2.1.10

5 years ago

2.1.9

5 years ago

2.1.8

5 years ago

2.1.7

5 years ago

2.1.6

5 years ago

2.1.5

5 years ago

2.1.4

5 years ago

2.1.3

5 years ago

2.1.2

5 years ago

2.1.0

5 years ago