Skip to main content

Class: 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()​

Call Signature​

static create(properties?): External & $Properties

Creates a new External instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

External & $Properties

External instance

Call Signature​

static create(properties?): External

Creates a new External instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

External

External instance

decode()​

static decode(reader, length?): External & $Properties

Decodes an External message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

External & $Properties

External

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): External & $Properties

Decodes an External message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

External & $Properties

External

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified External message. Does not implicitly temporal.api.nexus.v1.EndpointTarget.External.verify|verify messages.

Parameters​

message​

$Properties

External message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified External message, length delimited. Does not implicitly temporal.api.nexus.v1.EndpointTarget.External.verify|verify messages.

Parameters​

message​

$Properties

External message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): External

Creates an External message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

External

External

toObject()​

static toObject(message, options?): object

Creates a plain object from an External message. Also converts values to other types if specified.

Parameters​

message​

External

External

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object