Class ActorHttpInvalidateListenable

An ActorHttpInvalidate actor that allows listeners to be attached.

See

ActorHttpInvalidate

Hierarchy (View Summary)

ActorHttpInvalidate
- ActorHttpInvalidateListenable

Index

Constructors

constructor

new ActorHttpInvalidateListenable(
args: IActorHttpInvalidateArgs,
): ActorHttpInvalidateListenable
Parameters
- args: IActorHttpInvalidateArgs
Returns ActorHttpInvalidateListenable
Overrides ActorHttpInvalidate.constructor
- Defined in bus-http-invalidate/lib/ActorHttpInvalidateListenable.ts:18

Properties

`Readonly`beforeActors

beforeActors: Actor<
    IActionHttpInvalidate,
    IActorTest,
    IActorHttpInvalidateOutput,
    undefined,
>[] = []

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

`Readonly`bus

bus: Bus<
    Actor<
        IActionHttpInvalidate,
        IActorTest,
        IActorHttpInvalidateOutput,
        undefined,
    >,
    IActionHttpInvalidate,
    IActorTest,
    IActorHttpInvalidateOutput,
    undefined,
>

The bus this actor subscribes to.

`Readonly`name

name: string

The name for this actor.

Default

{<rdf:subject>}

Methods

addInvalidateListener

addInvalidateListener(listener: IInvalidateListener): void
Parameters
- listener: IInvalidateListener
Returns void
- Defined in bus-http-invalidate/lib/ActorHttpInvalidateListenable.ts:23

`Protected`getDefaultLogData

getDefaultLogData(context: IActionContext, data?: () => any): any
Parameters
- context: IActionContext
- Optionaldata: () => any
Returns any
Inherited from ActorHttpInvalidate.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 ActorHttpInvalidate.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 ActorHttpInvalidate.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 ActorHttpInvalidate.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 ActorHttpInvalidate.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 ActorHttpInvalidate.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 ActorHttpInvalidate.logWarn
- Defined in core/lib/Actor.ts:122

run

run(action: IActionHttpInvalidate): Promise<IActorHttpInvalidateOutput>
Run the given action on this actor.

In most cases, this method should not be called directly. Instead, #runObservable should be called.
Parameters
- action: IActionHttpInvalidate
  The action to run.
Returns Promise<IActorHttpInvalidateOutput>
A promise that resolves to the run result.
Overrides ActorHttpInvalidate.run
- Defined in bus-http-invalidate/lib/ActorHttpInvalidateListenable.ts:31

runObservable

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

test

test(_action: IActionHttpInvalidate): Promise<TestResult<IActorTest>>
Check if this actor can run the given action, without actually running it.
Parameters
- _action: IActionHttpInvalidate
Returns Promise<TestResult<IActorTest>>
A promise that resolves to the test result.
Overrides ActorHttpInvalidate.test
- Defined in bus-http-invalidate/lib/ActorHttpInvalidateListenable.ts:27

`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 ActorHttpInvalidate.getContextLogger
- Defined in core/lib/Actor.ts:56

Class ActorHttpInvalidateListenable

See

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActorHttpInvalidateListenable

Properties

ReadonlybeforeActors

Readonlybus

Readonlyname

Default

Methods

addInvalidateListener

Parameters

Returns void

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

run

Parameters

Returns Promise<IActorHttpInvalidateOutput>

runObservable

Parameters

Returns Promise<IActorHttpInvalidateOutput>

test

Parameters

Returns Promise<TestResult<IActorTest>>

StaticgetContextLogger

Parameters

Returns undefined | Logger

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`getContextLogger