Interface to define input for AbstractRestClient.request method

export
interface

  IRestOptions

### Hierarchy

- IRestOptions

## Index

### Properties

- normalizeRequestNewLines
- normalizeResponseNewLines
- reqHeaders
- request
- requestStream
- resource
- responseStream
- task
- writeData

## Properties

### Optional normalizeRequestNewLines

normalizeRequestNewLines: boolean

- Defined in @zowe/imperative/src/rest/src/client/doc/IRestOptions.ts:79

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

  IRestOptions

### Optional normalizeResponseNewLines

normalizeResponseNewLines: boolean

- Defined in @zowe/imperative/src/rest/src/client/doc/IRestOptions.ts:71

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

  IRestOptions

### Optional reqHeaders

reqHeaders: any[]

- Defined in @zowe/imperative/src/rest/src/client/doc/IRestOptions.ts:42

Headers to include with request

memberof

  IRestOptions

### request

request: HTTP_VERB

- Defined in @zowe/imperative/src/rest/src/client/doc/IRestOptions.ts:35

REST request type GET|PUT|POST|DELETE

memberof

  IRestOptions

### Optional requestStream

requestStream: Readable

- Defined in @zowe/imperative/src/rest/src/client/doc/IRestOptions.ts:63

Stream for outgoing request data to the server

memberof

  IRestOptions

### resource

resource: string

- Defined in @zowe/imperative/src/rest/src/client/doc/IRestOptions.ts:28

URI for this request

memberof

  IRestOptions

### Optional responseStream

responseStream: Writable

- Defined in @zowe/imperative/src/rest/src/client/doc/IRestOptions.ts:56

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

memberof

  IRestOptions

### Optional task

task: ITaskWithStatus

- Defined in @zowe/imperative/src/rest/src/client/doc/IRestOptions.ts:86

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

memberof

  IRestOptions

### Optional writeData

writeData: any

- Defined in @zowe/imperative/src/rest/src/client/doc/IRestOptions.ts:49

Data to write on this REST request

memberof

  IRestOptions

Generated using TypeDoc