ConnectionRequest

Request object for creating a connection

Request object for creating a connection.

Extends

• BaseDataSourceRequest<ConnectionRequestInput>

Constructors

Constructor

new ConnectionRequest(data): ConnectionRequest

Parameters

data

ConnectionRequestInput

Returns

ConnectionRequest

Inherited from

BaseDataSourceRequest<ConnectionRequestInput>.constructor

Methods

data()

data(): ConnectionRequestInput

Returns data encapsulated by the Request

Returns

ConnectionRequestInput

Inherited from

BaseDataSourceRequest.data

---

toJSON()

toJSON(): ConnectionRequestInput

Method to allow JSON serializers to only serialize the wrapped request data without serializing any of the Request object data

Returns

ConnectionRequestInput

See

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#description

Inherited from

BaseDataSourceRequest.toJSON

---

validate()

validate(): BWellTransactionResult<null, ValidationError>

Validate the request.

Returns

BWellTransactionResult<null, ValidationError>

a BWellTransactionResult describing any validation errors found

Inherited from

BaseDataSourceRequest.validate