Class ActorHttpFetch

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

Hierarchy (View Summary)

ActorHttp
- ActorHttpFetch

Constructors

constructor

new ActorHttpFetch(args: IActorHttpFetchArgs): ActorHttpFetch
Parameters
- args: IActorHttpFetchArgs
Returns ActorHttpFetch
Overrides ActorHttp.constructor
- Defined in actor-http-fetch/lib/ActorHttpFetch.ts:19

Properties

`Readonly`beforeActors

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

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

`Readonly`bus

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

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 ActorHttp.getDefaultLogData
- Defined in 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 ActorHttp.logDebug
- Defined in 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 ActorHttp.logError
- Defined in 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 ActorHttp.logFatal
- Defined in 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 ActorHttp.logInfo
- Defined in 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 ActorHttp.logTrace
- Defined in 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 ActorHttp.logWarn
- Defined in core/lib/Actor.ts:122

prepareRequestHeaders

prepareRequestHeaders(action: IActionHttp): Headers
Prepares the request headers, taking into account the environment.
Parameters
- action: IActionHttp
  The HTTP action
Returns Headers
Headers
- Defined in actor-http-fetch/lib/ActorHttpFetch.ts:76

run

run(action: IActionHttp): 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.
Returns Promise<IActorHttpOutput>
A promise that resolves to the run result.
Overrides ActorHttp.run
- Defined in actor-http-fetch/lib/ActorHttpFetch.ts:28

runObservable

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

test

test(_action: IActionHttp): Promise<TestResult<IMediatorTypeTime>>
Check if this actor can run the given action, without actually running it.
Parameters
- _action: IActionHttp
Returns Promise<TestResult<IMediatorTypeTime>>
A promise that resolves to the test result.
Overrides ActorHttp.test
- Defined in actor-http-fetch/lib/ActorHttpFetch.ts:24

`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
Inherited from ActorHttp.createUserAgent
- Defined in 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 ActorHttp.getContextLogger
- Defined in 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.
Inherited from ActorHttp.getInputUrl
- Defined in 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>
Inherited from ActorHttp.headersToHash
- Defined in 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.
Inherited from ActorHttp.isBrowser
- Defined in bus-http/lib/ActorHttp.ts:114

`Static`stringToBase64

stringToBase64(value: string): string
Converts a string, including ones with Unicode symbols, to Base64 encoding. This function was adapted from the MDN example function here: https://developer.mozilla.org/en-US/docs/Glossary/Base64#the_unicode_problem
Parameters
- value: string
  The string value to encode
Returns string
The Base64-encoded value
- Defined in actor-http-fetch/lib/ActorHttpFetch.ts:102

`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.
Inherited from ActorHttp.toNodeReadable
- Defined in 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.
Inherited from ActorHttp.toWebReadableStream
- Defined in bus-http/lib/ActorHttp.ts:49

Class ActorHttpFetch

See

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActorHttpFetch

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

prepareRequestHeaders

Parameters

Returns Headers

run

Parameters

Returns Promise<IActorHttpOutput>

runObservable

Parameters

Returns Promise<IActorHttpOutput>

test

Parameters

Returns Promise<TestResult<IMediatorTypeTime>>

StaticcreateUserAgent

Parameters

Returns undefined | string

StaticgetContextLogger

Parameters

Returns undefined | Logger

StaticgetInputUrl

Parameters

Returns URL

StaticheadersToHash

Parameters

Returns Record<string, string>

StaticisBrowser

Returns boolean

StaticstringToBase64

Parameters

Returns string

StatictoNodeReadable

Parameters

Returns ReadableStream

StatictoWebReadableStream

Parameters

Returns ReadableStream<any>

Settings

On This Page

`Readonly`beforeActors

`Readonly`bus

`Readonly`name

`Protected`getDefaultLogData

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

`Static`createUserAgent

`Static`getContextLogger

`Static`getInputUrl

`Static`headersToHash

`Static`isBrowser

`Static`stringToBase64

`Static`toNodeReadable

`Static`toWebReadableStream