neft

> [Wiki](Home) ▸ [[API Reference|API-Reference]] ▸ [[Networking|Networking-API]] ▸ **Request** # Request > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/networking/request.litcoffee) ## Table of contents * [Request](#request) * [**Class** Request](#class-request) * [METHODS](#methods) * [TYPES](#types) * [constructor](#constructor) * [onLoadEnd](#onloadend) * [uid](#uid) * [pending](#pending) * [method](#method) * [uri](#uri) * [type](#type) * [*Object* Request::data = null](#object-requestdata--null) * [handler](#handler) * [response](#response) * [ReadOnly *Object* Request::params = {}](#readonly-object-requestparams--) * [headers](#headers) * [cookies](#cookies) * [toString](#tostring) * [Glossary](#glossary) # **Class** Request > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/networking/request.litcoffee) ##METHODS <dl><dt>Syntax</dt><dd><code>*Array* Request.METHODS</code></dd><dt>Static property of</dt><dd>Request</dd><dt>Type</dt><dd>Array</dd></dl> Contains available [HTTP](/Neft-io/neft/wiki/Networking-API#class-networking) methods. Contains: - Request.GET, - Request.POST, - Request.PUT, - Request.DELETE, - Request.OPTIONS. > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/networking/request.litcoffee#array-requestmethods) ##TYPES <dl><dt>Syntax</dt><dd><code>*Array* Request.TYPES</code></dd><dt>Static property of</dt><dd>Request</dd><dt>Type</dt><dd>Array</dd></dl> Contains available expected types. Contains: - Request.TEXT_TYPE, - Request.JSON_TYPE, - Request.HTML_TYPE, - Request.BINARY_TYPE. > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/networking/request.litcoffee#array-requesttypes) ##constructor <dl><dt>Syntax</dt><dd><code>Request::constructor(*Object* options)</code></dd><dt>Prototype method of</dt><dd>Request</dd><dt>Parameters</dt><dd><ul><li>options — <a href="/Neft-io/neft/wiki/Utils-API#isobject">Object</a></li></ul></dd></dl> Class used to describe coming networking request. You should use `createRequest()` to create a full request. Access it with: ```javascript var Networking = require('networking'); var Request = Networking.Request; ``` > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/networking/request.litcoffee#requestconstructorobject-options) ##onLoadEnd <dl><dt>Syntax</dt><dd><code>*Signal* Request::onLoadEnd(*Any* error, *Any* data)</code></dd><dt>Prototype method of</dt><dd>Request</dd><dt>Parameters</dt><dd><ul><li>error — Any</li><li>data — Any</li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/networking/request.litcoffee#signal-requestonloadendany-error-any-data) ##uid <dl><dt>Syntax</dt><dd><code>ReadOnly *String* Request::uid</code></dd><dt>Prototype property of</dt><dd>Request</dd><dt>Type</dt><dd>String</dd><dt>Read Only</dt></dl> Pseudo unique hash. It's created automatically. > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/networking/request.litcoffee#readonly-string-requestuid) ##pending <dl><dt>Syntax</dt><dd><code>ReadOnly *Boolean* Request::pending</code></dd><dt>Prototype property of</dt><dd>Request</dd><dt>Type</dt><dd>Boolean</dd><dt>Read Only</dt></dl> Indicates whether the request is not destroyed. If it's `false`, the request can't be changed. > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/networking/request.litcoffee#readonly-boolean-requestpending) ##method <dl><dt>Syntax</dt><dd><code>*String* Request::method</code></dd><dt>Prototype property of</dt><dd>Request</dd><dt>Type</dt><dd>String</dd></dl> This property refers to one of the `Request.METHODS` values. Holds a method with which the request has been called. > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/networking/request.litcoffee#string-requestmethod) ##uri <dl><dt>Syntax</dt><dd><code>*Networking.Uri* Request::uri</code></dd><dt>Prototype property of</dt><dd>Request</dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Networking-Uri-API#class-uri">Networking.Uri</a></dd></dl> Refers to the request URI path. It can holds local and absolute paths. ```javascript // for request sent to the server ... "http://server.domain/auth/user" // for got request on the server ... "http://server.domain/auth/user" // for local requests ... "/user/user_id" ``` > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/networking/request.litcoffee#networkinguri-requesturi) ##type <dl><dt>Syntax</dt><dd><code>*String* Request::type</code></dd><dt>Prototype property of</dt><dd>Request</dd><dt>Type</dt><dd>String</dd></dl> Describes the expected response type. It's used in the server-client communication. In most cases, a server returns a HTML document for a crawler, but client (which renders documents on his own side) expects a clean JSON response. That's why, these two requests have the same uri, but different expected types. It refers to one of the *Request.TYPES* values. > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/networking/request.litcoffee#string-requesttype) ## [Object](/Neft-io/neft/wiki/Utils-API#isobject) Request::data = null Holds a data sent with a request. It can be, for instance, a form data. > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/networking/request.litcoffee) ##handler <dl><dt>Syntax</dt><dd><code>ReadOnly *Networking.Handler* Request::handler</code></dd><dt>Prototype property of</dt><dd>Request</dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Networking-Handler-API#class-handler">Networking.Handler</a></dd><dt>Read Only</dt></dl> Refers to the currently considered [Handler][networking/Handler]. > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/networking/request.litcoffee#readonly-networkinghandler-requesthandler) ##response <dl><dt>Syntax</dt><dd><code>ReadOnly *Networking.Response* Request::response</code></dd><dt>Prototype property of</dt><dd>Request</dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Networking-Response-API#class-response">Networking.Response</a></dd><dt>Read Only</dt></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/networking/request.litcoffee#readonly-networkingresponse-requestresponse) ## ReadOnly [Object](/Neft-io/neft/wiki/Utils-API#isobject) Request::params = {} Keeps matched parameters by the handler from the request uri. Considering the */users/{name}* URI, the 'name' property is available as the *params.name*. > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/networking/request.litcoffee) ##headers <dl><dt>Syntax</dt><dd><code>ReadOnly *Object* Request::headers</code></dd><dt>Prototype property of</dt><dd>Request</dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Utils-API#isobject">Object</a></dd><dt>Read Only</dt></dl> Contains request headers. For the client request, this object is empty. > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/networking/request.litcoffee#readonly-object-requestheaders) ##cookies <dl><dt>Syntax</dt><dd><code>ReadOnly *Object* Request::cookies</code></dd><dt>Prototype property of</dt><dd>Request</dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Utils-API#isobject">Object</a></dd><dt>Read Only</dt></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/networking/request.litcoffee#readonly-object-requestcookies) ##toString <dl><dt>Syntax</dt><dd><code>*String* Request::toString()</code></dd><dt>Prototype method of</dt><dd>Request</dd><dt>Returns</dt><dd>String</dd></dl> Returns a string describing the request. It contains a method, uri and a type. ```javascript console.log(req.toString); // get /users/id as json ``` > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/networking/request.litcoffee#string-requesttostring) # Glossary - [Networking.Request](#class-request)