Class: External
v1.EndpointTarget.External
Target an external server by URL. At a later point, this will support providing credentials, in the meantime, an http.RoundTripper can be injected into the server to modify the request.
Properties
url
• url: string
URL to call.
Methods
toJSON
▸ toJSON(): Object
Converts this External to JSON.
Returns
Object
JSON object
create
▸ create(properties?): External & $Properties
Creates a new External instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
External instance
▸ create(properties?): External
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): External & $Properties
Decodes an External message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
External
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): External & $Properties
Decodes an External message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
External
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified External message. Does not implicitly temporal.api.nexus.v1.EndpointTarget.External.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | External message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified External message, length delimited. Does not implicitly temporal.api.nexus.v1.EndpointTarget.External.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | External message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): External
Creates an External message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
External
toObject
▸ toObject(message, options?): Object
Creates a plain object from an External message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | External | External |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object