Preparing search index...
The search index is not available
@octopusdeploy/api-client
@octopusdeploy/api-client
ClientOptions
Interface ClientOptions
Hierarchy
ClientOptions
Index
Properties
configuration
error
method?
non
Stale?
on
Error
Response
Callback
on
Request
Callback
on
Response
Callback
raw?
request
Body?
success
url
Properties
configuration
configuration
:
ClientConfiguration
error
error
:
(
(
error
:
Error
)
=>
void
)
Type declaration
(
error
:
Error
)
:
void
Parameters
error:
Error
Returns
void
Optional
method
method
?:
string
Optional
non
Stale
non
Stale
?:
boolean
on
Error
Response
Callback
on
Error
Response
Callback
:
(
(
details
:
ClientErrorResponseDetails
)
=>
void
)
Type declaration
(
details
:
ClientErrorResponseDetails
)
:
void
Parameters
details:
ClientErrorResponseDetails
Returns
void
on
Request
Callback
on
Request
Callback
:
(
(
details
:
ClientRequestDetails
)
=>
void
)
Type declaration
(
details
:
ClientRequestDetails
)
:
void
Parameters
details:
ClientRequestDetails
Returns
void
on
Response
Callback
on
Response
Callback
:
(
(
details
:
ClientResponseDetails
)
=>
void
)
Type declaration
(
details
:
ClientResponseDetails
)
:
void
Parameters
details:
ClientResponseDetails
Returns
void
Optional
raw
raw
?:
boolean
Optional
request
Body
request
Body
?:
any
success
success
:
(
(
data
:
string
|
PromiseLike
<
string
>
)
=>
void
)
Type declaration
(
data
:
string
|
PromiseLike
<
string
>
)
:
void
Parameters
data:
string
|
PromiseLike
<
string
>
Returns
void
url
url
:
string
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
Modules
@octopusdeploy/api-
client
Client
Options
configuration
error
method?
non
Stale?
on
Error
Response
Callback
on
Request
Callback
on
Response
Callback
raw?
request
Body?
success
url
Generated using
TypeDoc