Class ActorHttp<TS>`Abstract`

A base actor for listening to HTTP events.

Actor types:

Input: IActionHttp: The HTTP request.
Test: IActorHttpTest: An estimate for the response time.
Output: IActorHttpOutput: The HTTP response.

See

IActionHttp
IActorHttpTest
IActorHttpOutput

Type Parameters

TS = undefined

Hierarchy (View Summary)

Actor<IActionHttp, IActorTest, IActorHttpOutput, TS>
- ActorHttp

Index

Constructors

constructor

new ActorHttp<TS = undefined>(args: IActorHttpArgs<TS>): ActorHttp<TS>
Type Parameters
- TS = undefined
Parameters
- args: IActorHttpArgs<TS>
  \
Returns ActorHttp<TS>
Default Nested
bus \

Default Nested
busFailMessage
Overrides Actor.constructor
- Defined in packages/bus-http/lib/ActorHttp.ts:28

Properties

`Readonly`beforeActors

beforeActors: Actor<IActionHttp, IActorTest, IActorHttpOutput, TS>[] = []

Actor that must be registered in the bus before this actor.

`Readonly`bus

bus: Bus<
    Actor<IActionHttp, IActorTest, IActorHttpOutput, TS>,
    IActionHttp,
    IActorTest,
    IActorHttpOutput,
    TS,
>

The bus this actor subscribes to.

`Readonly`name

name: string

The name for this actor.

Default

{<rdf:subject>}

Methods

`Protected`getDefaultLogData

getDefaultLogData(context: IActionContext, data?: () => any): any
Parameters
- context: IActionContext
- Optionaldata: () => any
Returns any
Inherited from Actor.getDefaultLogData
- Defined in packages/core/lib/Actor.ts:95

`Protected`logDebug

logDebug(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from Actor.logDebug
- Defined in packages/core/lib/Actor.ts:108

`Protected`logError

logError(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from Actor.logError
- Defined in packages/core/lib/Actor.ts:129

`Protected`logFatal

logFatal(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from Actor.logFatal
- Defined in packages/core/lib/Actor.ts:136

`Protected`logInfo

logInfo(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from Actor.logInfo
- Defined in packages/core/lib/Actor.ts:115

`Protected`logTrace

logTrace(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from Actor.logTrace
- Defined in packages/core/lib/Actor.ts:101

`Protected`logWarn

logWarn(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from Actor.logWarn
- Defined in packages/core/lib/Actor.ts:122

`Abstract`run

run(action: IActionHttp, sideData: TS): Promise<IActorHttpOutput>
Run the given action on this actor.

In most cases, this method should not be called directly. Instead, #runObservable should be called.
Parameters
- action: IActionHttp
  The action to run.
- sideData: TS
Returns Promise<IActorHttpOutput>
A promise that resolves to the run result.
Inherited from Actor.run
- Defined in packages/core/lib/Actor.ts:78

runObservable

runObservable(action: IActionHttp, sideData: TS): Promise<IActorHttpOutput>
Run the given action on this actor AND invokes the Bus#onRun method.
Parameters
- action: IActionHttp
  The action to run.
- sideData: TS
Returns Promise<IActorHttpOutput>
A promise that resolves to the run result.
Inherited from Actor.runObservable
- Defined in packages/core/lib/Actor.ts:87

`Abstract`test

test(action: IActionHttp): Promise<TestResult<IActorTest, TS>>
Check if this actor can run the given action, without actually running it.
Parameters
- action: IActionHttp
  The action to test.
Returns Promise<TestResult<IActorTest, TS>>
A promise that resolves to the test result.
Inherited from Actor.test
- Defined in packages/core/lib/Actor.ts:67

`Static`createUserAgent

createUserAgent(actorName: string, actorVersion: string): undefined | string
Creates an appropriate User-Agent header string for Node.js or other environments. Within browsers, returns undefined, because the value should not be overridden due to potential CORS issues.
Parameters
- actorName: string
- actorVersion: string
Returns undefined | string
- Defined in packages/bus-http/lib/ActorHttp.ts:79

`Static`getContextLogger

getContextLogger(context: IActionContext): undefined | Logger
Get the logger from the given context.
Parameters
- context: IActionContext
  An optional context.
Returns undefined | Logger
The logger or undefined.
Inherited from Actor.getContextLogger
- Defined in packages/core/lib/Actor.ts:56

`Static`getInputUrl

getInputUrl(input: RequestInfo | URL): URL
Extract the requested URL from the action input.
Parameters
- input: RequestInfo | URL
  The request input.
Returns URL
The extracted URL.
- Defined in packages/bus-http/lib/ActorHttp.ts:71

`Static`headersToHash

headersToHash(headers: Headers): Record<string, string>
Convert the given headers object into a raw hash.
Parameters
- headers: Headers
  A headers object.
Returns Record<string, string>
- Defined in packages/bus-http/lib/ActorHttp.ts:57

`Static`isBrowser

isBrowser(): boolean
Attempts to determine whether the current environment is a browser or not.

Returns boolean
True for browsers and web workers, false for other runtimes.
- Defined in packages/bus-http/lib/ActorHttp.ts:114

`Static`toNodeReadable

toNodeReadable(body: null | ReadableStream<any>): ReadableStream
Converts WhatWG streams to Node streams if required. Returns the input in case the stream already is a Node stream.
Parameters
- body: null | ReadableStream<any>
Returns ReadableStream
A node stream.
- Defined in packages/bus-http/lib/ActorHttp.ts:38

`Static`toWebReadableStream

toWebReadableStream(body: null | ReadableStream): ReadableStream<any>
Converts Node streams to WhatWG streams.
Parameters
- body: null | ReadableStream
Returns ReadableStream<any>
A web stream.
- Defined in packages/bus-http/lib/ActorHttp.ts:49

Class ActorHttp<TS>Abstract

See

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ActorHttp<TS>

Default Nested

Default Nested

Properties

ReadonlybeforeActors

Readonlybus

Readonlyname

Default

Methods

ProtectedgetDefaultLogData

Parameters

Returns any

ProtectedlogDebug

Parameters

Returns void

ProtectedlogError

Parameters

Returns void

ProtectedlogFatal

Parameters

Returns void

ProtectedlogInfo

Parameters

Returns void

ProtectedlogTrace

Parameters

Returns void

ProtectedlogWarn

Parameters

Returns void

Abstractrun

Parameters

Returns Promise<IActorHttpOutput>

runObservable

Parameters

Returns Promise<IActorHttpOutput>

Abstracttest

Parameters

Returns Promise<TestResult<IActorTest, TS>>

StaticcreateUserAgent

Parameters

Returns undefined | string

StaticgetContextLogger

Parameters

Returns undefined | Logger

StaticgetInputUrl

Parameters

Returns URL

StaticheadersToHash

Parameters

Returns Record<string, string>

StaticisBrowser

Returns boolean

StatictoNodeReadable

Parameters

Returns ReadableStream

StatictoWebReadableStream

Parameters

Returns ReadableStream<any>

Settings

On This Page

Class ActorHttp<TS>`Abstract`

`Readonly`beforeActors

`Readonly`bus

`Readonly`name

`Protected`getDefaultLogData

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

`Abstract`run

`Abstract`test

`Static`createUserAgent

`Static`getContextLogger

`Static`getInputUrl

`Static`headersToHash

`Static`isBrowser

`Static`toNodeReadable

`Static`toWebReadableStream