Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IOptionsFullResponse

Interface to define input options for RestClient GET|POST|PUT|DELETE ExpectFullResponse methods

export
interface

IOptionsFullResponse

Hierarchy

  • IOptionsFullResponse

Index

Properties

Optional dataToReturn

dataToReturn: CLIENT_PROPERTY[]

List of properties to return from REST call

memberof

IFullResponseOptions

Optional normalizeRequestNewLines

normalizeRequestNewLines: boolean

true if you want \r\n to be replaced with \n when sending data to the server from requestStream. Don't set this for binary requests

memberof

IOptionsFullResponse

Optional normalizeResponseNewLines

normalizeResponseNewLines: boolean

true if you want newlines to be \r\n on windows when receiving data from the server to responseStream. Don't set this for binary responses

memberof

IOptionsFullResponse

Optional reqHeaders

reqHeaders: any[]

Headers to include with request

memberof

IOptionsFullResponse

Optional requestStream

requestStream: Readable

Stream for outgoing request data to the server

memberof

IOptionsFullResponse

resource

resource: string

URI for this request

memberof

IOptionsFullResponse

Optional responseStream

responseStream: Writable

Stream for incoming response data from the server. If specified, response data will not be buffered

memberof

IOptionsFullResponse

Optional task

task: ITaskWithStatus

Task that will automatically be updated to report progress of upload or download to user

memberof

IOptionsFullResponse

Optional writeData

writeData: any

Data to write on this REST request

memberof

IOptionsFullResponse

Generated using TypeDoc