Class ControlledHttpRequest

Default implementation of ManagedRequest for managing HTTP request lifecycle and cancellation.

Hierarchy

ControlledHttpRequest

Implements

ManagedRequest

Index

Constructors

constructor

Properties

Accessors

Methods

abort

Constructors

constructor

new ControlledHttpRequest(requestType: RequestControlMode): ControlledHttpRequest

- Defined in core-sdk/src/lib/http/request-control/controlled-http-request.ts:22
Private constructor for controlled http request

example
const request = new ControlledHttpRequest(requestType)

Parameters
- requestType: RequestControlMode
Returns ControlledHttpRequest

Properties

Private abortedInternal

abortedInternal: boolean = false

Private controller

controller: AbortController = ...

createdAt

createdAt: number = ...

remarks

Timestamp indicating when the request was created.

id

id: string = ...

remarks

Unique identifier for tracking the request instance.

Private Readonly logger

logger: Logger

requestType

requestType: RequestControlMode

remarks

Defines how the request should be controlled. Determines whether the request should be delayed, aborted, or both when multiple requests are triggered.

Accessors

aborted

get aborted(): boolean

Implementation of ManagedRequest.aborted
- Defined in core-sdk/src/lib/http/request-control/controlled-http-request.ts:49
Gets whether this request has been aborted.
example
```
const managedRequest = new ControlledHttpRequest(requestType);
if (managedRequest.aborted) {
  console.log('Request was aborted');
}
```
Returns boolean

signal

get signal(): AbortSignal

Implementation of ManagedRequest.signal
- Defined in core-sdk/src/lib/http/request-control/controlled-http-request.ts:35
Gets the AbortSignal associated with this request.
example
```
const managedRequest = new ControlledHttpRequest(requestType);
fetch(url, { signal: managedRequest.signal });
```
Returns AbortSignal

Methods

abort

abort(reason?: string): void

Implementation of ManagedRequest.abort
- Defined in core-sdk/src/lib/http/request-control/controlled-http-request.ts:62
Aborts the request with an optional reason.
example
```
const managedRequest = new ControlledHttpRequest(requestType);
managedRequest.abort('user_cancelled');
```
Parameters
- Optional reason: string
  
  The reason for aborting the request.
Returns void

Generated using TypeDoc