LabGroupsRequest

Request object for fetching lab groups data

Request object for fetching lab groups data.

Extends

Constructors

Constructor

new LabGroupsRequest(data): LabGroupsRequest

Parameters

data

PagedRequestInput

Returns

LabGroupsRequest

Inherited from

PagedRequest.constructor

Methods

transformInput()

transformInput(input): PagedRequestInput & Required<PagedRequestInput>

Allows classes to transform input data (I) into data of type T. This is useful when defaulting certain parameters or otherwise providing a different public api than what the internal api requries

This is the default no-op version of the method that should be overriden when types T and I are not the same or input and output data differ

Parameters

input

PagedRequestInput

user provided data to transform to type T

Returns

PagedRequestInput & Required<PagedRequestInput>

Inherited from

PagedRequest.transformInput


data()

data(): PagedRequestInput & Required<PagedRequestInput>

Returns data encapsulated by the Request

Returns

PagedRequestInput & Required<PagedRequestInput>

Inherited from

PagedRequest.data


toJSON()

toJSON(): PagedRequestInput & Required<PagedRequestInput>

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

Returns

PagedRequestInput & Required<PagedRequestInput>

See

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

Inherited from

PagedRequest.toJSON


validate()

validate(): BWellTransactionResult<null, ValidationError>

Validate the request.

Returns

BWellTransactionResult<null, ValidationError>

a BWellTransactionResult describing any validation errors found

Inherited from

PagedRequest.validate