Class ActorHttpNative

A comunica Follow Redirects Http Actor.

Hierarchy (view full)

ActorHttp
- ActorHttpNative

Index

Constructors

constructor

new ActorHttpNative(args): ActorHttpNative
Parameters
- args: IActorHttpNativeArgs
Returns ActorHttpNative
Overrides ActorHttp.constructor
- Defined in actor-http-native/lib/ActorHttpNative.ts:18

Properties

`Readonly` beforeActors

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

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

`Readonly` bus

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

The bus this actor subscribes to.

`Readonly` name

name: string

The name for this actor.

Default

{<rdf:subject>}

`Private` `Readonly` requester

requester: default

`Private` `Readonly` userAgent

userAgent: string

Methods

deinitialize

deinitialize(): Promise<any>
Deinitialize this actor. This should be used for cleaning up things when the application is shut down, such as closing files and removing temporary files.

Returns Promise<any>
A promise that resolves when the actor has been deinitialized.
Inherited from ActorHttp.deinitialize
- Defined in core/lib/Actor.ts:106

`Protected` getDefaultLogData

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

initialize

initialize(): Promise<any>
Initialize this actor. This should be used for doing things that take a while, such as opening files.

Returns Promise<any>
A promise that resolves when the actor has been initialized.
Inherited from ActorHttp.initialize
- Defined in core/lib/Actor.ts:95

`Protected` logDebug

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

`Protected` logError

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

`Protected` logFatal

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

`Protected` logInfo

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

`Protected` logTrace

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

`Protected` logWarn

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

run

run(action): 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-native/lib/ActorHttpNative.ts:34

runObservable

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

test

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

`Static` createUserAgent

createUserAgent(): string
Returns string
- Defined in actor-http-native/lib/ActorHttpNative.ts:24

`Static` getContextLogger

getContextLogger(context): 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:51

`Static` headersToHash

headersToHash(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:58

`Static` toNodeReadable

toNodeReadable(body): 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:39

`Static` toWebReadableStream

toWebReadableStream(body): 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:50

Class ActorHttpNative

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActorHttpNative

Properties

Readonly beforeActors

Readonly bus

Readonly name

Default

Private Readonly requester

Private Readonly userAgent

Methods

deinitialize

Returns Promise<any>

Protected getDefaultLogData

Parameters

Returns any

Returns any

initialize

Returns Promise<any>

Protected logDebug

Parameters

Returns any

Returns void

Protected logError

Parameters

Returns any

Returns void

Protected logFatal

Parameters

Returns any

Returns void

Protected logInfo

Parameters

Returns any

Returns void

Protected logTrace

Parameters

Returns any

Returns void

Protected logWarn

Parameters

Returns any

Returns void

run

Parameters

Returns Promise<IActorHttpOutput>

runObservable

Parameters

Returns Promise<IActorHttpOutput>

test

Parameters

Returns Promise<IMediatorTypeTime>

Static createUserAgent

Returns string

Static getContextLogger

Parameters

Returns undefined | Logger

Static headersToHash

Parameters

Returns Record<string, string>

Static toNodeReadable

Parameters

Returns ReadableStream

Static toWebReadableStream

Parameters

Returns ReadableStream<any>

Settings

Member Visibility

Theme

On This Page

`Readonly` beforeActors

`Readonly` bus

`Readonly` name

`Private` `Readonly` requester

`Private` `Readonly` userAgent

`Protected` getDefaultLogData

`Protected` logDebug

`Protected` logError

`Protected` logFatal

`Protected` logInfo

`Protected` logTrace

`Protected` logWarn

`Static` createUserAgent

`Static` getContextLogger

`Static` headersToHash

`Static` toNodeReadable

`Static` toWebReadableStream