SGAppsServerResponse - SGApps Server

new SGAppsServerResponse(response, server)

Source:

prototypes/server/response.js, line 4

Parameters:

Name	Type	Description
`response`	ServerResponse
`server`	SGAppsServer

Members

_destroy :Array.<function()>

Source:

prototypes/server/response.js, line 19

Array of functions to be called on response end

Type:

Array.<function()>

_flags :object

Source:

prototypes/server/response.js, line 28

Properties:

Name	Type	Description
`finished`	boolean	will be true if response.end() has been called.
`sent`	boolean	Is true if all data has been flushed to the underlying system, immediately before the 'finish' event is emitted.
`closed`	boolean	Indicates that the the response is completed, or its underlying connection was terminated prematurely (before the response completion).

Array of functions to be called on response end

Type:

object

response :ServerResponse

Source:

prototypes/server/response.js, line 12

Type:

ServerResponse

Methods

pipeFile(filePath, callback)

Source:

prototypes/server/extend/response-pipe-file.js, line 14

Parameters:

Name	Type	Description
`filePath`	string
`callback`	SGAppsServerErrorOnlyCallback	represents a `Function(Error)`

pipeFileStatic(filePath, fileName, callback, optionsopt)

Source:

prototypes/server/extend/response-pipe-file-static.js, line 26

Parameters:

Name Type Attributes Description

filePath string

fileName string

callback SGAppsServerResponse.pipeFileStaticCallback

options

object

Properties

Name	Type	Attributes	Default	Description
`timeout`	number	<optional>	`0`
`filePath`	string	<optional>		originap path is autoIndex was applied
`autoIndex`	Array.<string>	<optional>		list of auto-index files, ex: ['index.html', 'index.htm', 'default.html']

redirect(url, optionsopt)

Source:

prototypes/server/extend/response-redirect.js, line 18

if it returns false than the action was not possible

Parameters:

Name Type Attributes Description

url string

options

object

Properties

Name	Type	Attributes	Default	Description
`statusCode`	number	<optional>	`302`
`headers`	Object.<string, (string\|Array.<string>)>	<optional>

send(data, optionsopt)

Source:

prototypes/server/extend/response-send.js, line 14

Parameters:

Name Type Attributes Description

data string | Buffer | object | Array.<any>

options

object

Properties

Name	Type	Attributes	Default	Description
`statusCode`	number	<optional>	`200`
`headers`	Object.<string, (string\|Array.<string>)>	<optional>

sendError(error, optionsopt)

Source:

prototypes/server/extend/response-error.js, line 18

Parameters:

Name Type Attributes Description

error Error

options

object

Properties

Name	Type	Attributes	Default	Description
`statusCode`	number	<optional>	`500`

sendStatusCode(statusCode)

Source:

prototypes/server/extend/response-send.js, line 85

Parameters:

Name	Type	Description
`statusCode`	number

Type Definitions

pipeFileStaticCallback(error)

Source:

prototypes/server/extend/response-pipe-file-static.js, line 19

Parameters:

Name	Type	Description
`error`	Error