From d9db3280ae567f5034635adefa8dbbd3547d0678 Mon Sep 17 00:00:00 2001 From: Theodor Diaconu Date: Mon, 7 Oct 2024 10:55:34 +0300 Subject: [PATCH] typedoc --- README.md | 1 - docs/classes/EventManager.html | 4 ++-- docs/classes/Store.html | 14 +++++++------- docs/classes/TaskRunner.html | 8 ++++---- docs/functions/event.html | 2 +- docs/functions/middleware.html | 2 +- docs/functions/resource.html | 2 +- docs/functions/run.html | 2 +- docs/functions/task.html | 2 +- docs/index.html | 1 - docs/interfaces/definitions.IEvent.html | 8 ++++---- docs/interfaces/definitions.IEventDefinition.html | 4 ++-- docs/interfaces/definitions.IEventMeta.html | 4 ++-- docs/interfaces/definitions.IHookDefinition.html | 6 +++--- docs/interfaces/definitions.IMeta.html | 4 ++-- docs/interfaces/definitions.IMiddleware.html | 4 ++-- .../definitions.IMiddlewareDefinition.html | 4 ++-- ...efinitions.IMiddlewareDefinitionConfigured.html | 4 ++-- .../definitions.IMiddlewareExecutionInput.html | 4 ++-- docs/interfaces/definitions.IMiddlewareMeta.html | 4 ++-- docs/interfaces/definitions.IResource.html | 8 ++++---- .../definitions.IResourceDefinintion.html | 6 +++--- docs/interfaces/definitions.IResourceMeta.html | 4 ++-- .../definitions.IResourceWithConfig.html | 4 ++-- docs/interfaces/definitions.ITask.html | 10 +++++----- docs/interfaces/definitions.ITaskDefinition.html | 8 ++++---- docs/interfaces/definitions.ITaskMeta.html | 4 ++-- docs/modules/definitions.html | 2 +- docs/types/definitions.AfterInitEventPayload.html | 2 +- docs/types/definitions.AfterRunEventPayload.html | 2 +- docs/types/definitions.BeforeInitEventPayload.html | 2 +- docs/types/definitions.BeforeRunEventPayload.html | 2 +- docs/types/definitions.DependencyMapType.html | 2 +- docs/types/definitions.DependencyValueType.html | 2 +- docs/types/definitions.DependencyValuesType.html | 2 +- docs/types/definitions.EventHandlerType.html | 2 +- docs/types/definitions.OnErrorEventPayload.html | 2 +- docs/types/definitions.RegisterableItems.html | 2 +- docs/variables/definitions.symbols.html | 2 +- docs/variables/globals.html | 2 +- 40 files changed, 76 insertions(+), 78 deletions(-) diff --git a/README.md b/README.md index 6baa742..882e34e 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,6 @@

Build Status -Build Status Coverage Status Docs

diff --git a/docs/classes/EventManager.html b/docs/classes/EventManager.html index 42371e3..b9a7d4b 100644 --- a/docs/classes/EventManager.html +++ b/docs/classes/EventManager.html @@ -156,14 +156,14 @@ --md-sys-color-surface-container-high: #e7e8ea; --md-sys-color-surface-container-highest: #e1e3e4 } -

Class EventManager

Constructors

constructor +

Class EventManager

Constructors

constructor

Accessors

isLocked

Methods

addGlobalListener addListener checkLock emit lock -

Constructors

constructor

Accessors

isLocked

Methods

addGlobalListener

addListener

checkLock

emit

lock

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods

Class Store

Store class which is used to store all the resources, tasks, middleware and events.

-

Constructors

constructor +

Constructors

constructor

Properties

eventManager events logger @@ -178,12 +178,12 @@ storeEvent storeEventsForAllTasks storeGenericItem -

Constructors

constructor

Properties

Protected ReadonlyeventManager

eventManager: EventManager

events

events: Map<string, EventStoreElementType> = ...

Protected Readonlylogger

logger: Logger

middlewares

middlewares: Map<string, MiddlewareStoreElementType<any>> = ...

overrides

overrides: Map<string,
    | IResource<void, any, any>
    | ITask<any, any, {}, null>
    | IMiddleware<any>
    | IResourceWithConfig<any, any, any>> = ...

resources

resources: Map<string, ResourceStoreElementType<any, any, {}>> = ...

root

root: ResourceStoreElementType<any, any, {}>

tasks

tasks: Map<string, TaskStoreElementType<any, any, any>> = ...

Accessors

isLocked

Methods

ProtectedcheckIfIDExists

  • checkIfIDExists(id): void

  • middlewares are already stored in their final form and the check for them would be redundant

    -

    Parameters

    • id: string

    Returns void

checkLock

dispose

getDependentNodes

getGlobalMiddlewares

initializeStore

  • initializeStore(root, config): void

  • Store the root before beginning registration

    -

    Parameters

    Returns void

lock

processOverrides

  • processOverrides(): void

  • When this is called, all overrides should have been stored in the "overrides" store.

    -

    Returns void

storeEvent

storeEventsForAllTasks

storeGenericItem

  • storeGenericItem<C>(item): void

  • If you want to register something to the store you can use this function.

    -

    Type Parameters

    • C

    Parameters

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods

Class TaskRunner

Constructors

constructor +

Class TaskRunner

Constructors

constructor

Properties

eventManager logger runnerStore store

Methods

createRunnerWithMiddleware run -

Constructors

constructor

Properties

Protected ReadonlyeventManager

eventManager: EventManager

Protected Readonlylogger

logger: Logger

Protected ReadonlyrunnerStore

runnerStore: Map<string, ((input: any) => Promise<any>)> = ...

Protected Readonlystore

store: Store

Methods

ProtectedcreateRunnerWithMiddleware

run

  • run<TInput, TOutput, TDeps>(task, input, taskDependencies?): Promise<undefined | TOutput>

  • Begins the execution of an task. These are registered tasks and all sanity checks have been performed at this stage to ensure consistency of the object. +

Constructors

constructor

Properties

Protected ReadonlyeventManager

eventManager: EventManager

Protected Readonlylogger

logger: Logger

Protected ReadonlyrunnerStore

runnerStore: Map<string, ((input: any) => Promise<any>)> = ...

Protected Readonlystore

store: Store

Methods

ProtectedcreateRunnerWithMiddleware

run

  • run<TInput, TOutput, TDeps>(task, input, taskDependencies?): Promise<undefined | TOutput>

  • Begins the execution of an task. These are registered tasks and all sanity checks have been performed at this stage to ensure consistency of the object. This function can throw only if any of the event listeners or run function throws

    Type Parameters

    Parameters

    • task: ITask<TInput, TOutput, TDeps, null>

      the task to be run

    • input: TInput

      the input to be passed to the task

    • OptionaltaskDependencies: DependencyValuesType<TDeps>

      optional dependencies to be passed to the task, if not provided, the dependencies will be the ones already computed from the store.

      -

    Returns Promise<undefined | TOutput>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods

Function event

Settings

Member Visibility

Function event

Settings

Member Visibility

Function middleware

Settings

Member Visibility

Function middleware

Settings

Member Visibility

Function resource

Settings

Member Visibility

Function resource

Settings

Member Visibility

Function run

  • run<C, V>(resource, config?): Promise<V>

  • Type Parameters

    • C
    • V

    Parameters

    Returns Promise<V>

Settings

Member Visibility

Function run

  • run<C, V>(resource, config?): Promise<V>

  • Type Parameters

    • C
    • V

    Parameters

    Returns Promise<V>

Settings

Member Visibility

Function task

Settings

Member Visibility

Function task

Settings

Member Visibility

@bluelibs/runner - v1.5.0

BlueLibs Runner

Build Status -Build Status Coverage Status Docs

diff --git a/docs/interfaces/definitions.IEvent.html b/docs/interfaces/definitions.IEvent.html index 8602ddb..aa7a700 100644 --- a/docs/interfaces/definitions.IEvent.html +++ b/docs/interfaces/definitions.IEvent.html @@ -156,14 +156,14 @@ --md-sys-color-surface-container-high: #e7e8ea; --md-sys-color-surface-container-highest: #e1e3e4 } -

Interface IEvent<TPayload>

interface IEvent<TPayload> {
    data: TPayload;
    id: string;
    source: string;
    timestamp: Date;
}

Type Parameters

  • TPayload = any

Properties

data +

Interface IEvent<TPayload>

interface IEvent<TPayload> {
    data: TPayload;
    id: string;
    source: string;
    timestamp: Date;
}

Type Parameters

  • TPayload = any

Properties

data id source timestamp

Properties

data

data: TPayload

The data that the event carries. It can be anything.

-

id

id: string

source

source: string

The source of the event. This can be useful for debugging.

-

timestamp

timestamp: Date

The timestamp when the event was created.

-

Settings

Member Visibility

On This Page

Properties

Interface IEventDefinition<TPayload>

interface IEventDefinition<TPayload> {
    id: string;
    meta?: IEventMeta;
}

Type Parameters

  • TPayload = void

Properties

id +

Interface IEventDefinition<TPayload>

interface IEventDefinition<TPayload> {
    id: string;
    meta?: IEventMeta;
}

Type Parameters

  • TPayload = void

Properties

id meta? -

Properties

id

id: string

Optionalmeta

meta?: IEventMeta

Settings

Member Visibility

On This Page

Properties

Interface IEventMeta

interface IEventMeta {
    description?: string;
    tags?: string[];
    title?: string;
}

Hierarchy (view full)

Properties

description? +

Interface IEventMeta

interface IEventMeta {
    description?: string;
    tags?: string[];
    title?: string;
}

Hierarchy (view full)

Properties

description? tags? title? -

Properties

Optionaldescription

description?: string

Optionaltags

tags?: string[]

Optionaltitle

title?: string

Settings

Member Visibility

On This Page

Properties

Interface IHookDefinition<D, T, B>

interface IHookDefinition<D, T, B> {
    early?: B;
    event: IEventDefinition<T> | "*";
    order?: number;
    run: ((event: IEvent<T>, dependencies: T extends true
        ? void
        : DependencyValuesType<D>) => void | Promise<void>);
}

Type Parameters

Properties

early? +

Interface IHookDefinition<D, T, B>

interface IHookDefinition<D, T, B> {
    early?: B;
    event: IEventDefinition<T> | "*";
    order?: number;
    run: ((event: IEvent<T>, dependencies: T extends true
        ? void
        : DependencyValuesType<D>) => void | Promise<void>);
}

Type Parameters

Properties

early? event order? run

Properties

Optionalearly

early?: B

These are hooks that run before any resource instantiation.

-

Param: event

event

event: IEventDefinition<T> | "*"

Optionalorder

order?: number

The higher the number, the higher the priority. +

Param: event

event

event: IEventDefinition<T> | "*"

Optionalorder

order?: number

The higher the number, the higher the priority. We recommend using numbers between -1000 and 1000.

-

run

run: ((event: IEvent<T>, dependencies: T extends true
    ? void
    : DependencyValuesType<D>) => void | Promise<void>)

Settings

Member Visibility

On This Page

Properties

Interface IMeta

interface IMeta {
    description?: string;
    tags?: string[];
    title?: string;
}

Hierarchy (view full)

Properties

description? +

Interface IMeta

interface IMeta {
    description?: string;
    tags?: string[];
    title?: string;
}

Hierarchy (view full)

Properties

description? tags? title? -

Properties

Optionaldescription

description?: string

Optionaltags

tags?: string[]

Optionaltitle

title?: string

Settings

Member Visibility

On This Page

Properties

Interface IMiddleware<TDependencies>

interface IMiddleware<TDependencies> {
    dependencies: TDependencies | (() => TDependencies);
    id: string;
    meta?: IMiddlewareMeta;
    run: ((input: IMiddlewareExecutionInput, dependencies: DependencyValuesType<TDependencies>) => Promise<any>);
    global(): IMiddleware<TDependencies>;
}

Type Parameters

Hierarchy (view full)

Properties

dependencies +

Interface IMiddleware<TDependencies>

interface IMiddleware<TDependencies> {
    dependencies: TDependencies | (() => TDependencies);
    id: string;
    meta?: IMiddlewareMeta;
    run: ((input: IMiddlewareExecutionInput, dependencies: DependencyValuesType<TDependencies>) => Promise<any>);
    global(): IMiddleware<TDependencies>;
}

Type Parameters

Hierarchy (view full)

Properties

dependencies id meta? run

Methods

global -

Properties

dependencies

dependencies: TDependencies | (() => TDependencies)

id

id: string

Optionalmeta

meta?: IMiddlewareMeta

run

run: ((input: IMiddlewareExecutionInput, dependencies: DependencyValuesType<TDependencies>) => Promise<any>)

Methods

global

Settings

Member Visibility

On This Page

Properties
Methods

Interface IMiddlewareDefinition<TDependencies>

interface IMiddlewareDefinition<TDependencies> {
    dependencies?: TDependencies | (() => TDependencies);
    id: string;
    meta?: IMiddlewareMeta;
    run: ((input: IMiddlewareExecutionInput, dependencies: DependencyValuesType<TDependencies>) => Promise<any>);
}

Type Parameters

Hierarchy (view full)

Properties

dependencies? +

Interface IMiddlewareDefinition<TDependencies>

interface IMiddlewareDefinition<TDependencies> {
    dependencies?: TDependencies | (() => TDependencies);
    id: string;
    meta?: IMiddlewareMeta;
    run: ((input: IMiddlewareExecutionInput, dependencies: DependencyValuesType<TDependencies>) => Promise<any>);
}

Type Parameters

Hierarchy (view full)

Properties

dependencies? id meta? run -

Properties

Optionaldependencies

dependencies?: TDependencies | (() => TDependencies)

id

id: string

Optionalmeta

meta?: IMiddlewareMeta

run

run: ((input: IMiddlewareExecutionInput, dependencies: DependencyValuesType<TDependencies>) => Promise<any>)

Settings

Member Visibility

On This Page

Properties

Interface IMiddlewareDefinitionConfigured<C>

interface IMiddlewareDefinitionConfigured<C> {
    config?: C;
    middleware: IMiddleware<C>;
}

Type Parameters

  • C extends Record<string, any> = {}

Properties

config? +

Interface IMiddlewareDefinitionConfigured<C>

interface IMiddlewareDefinitionConfigured<C> {
    config?: C;
    middleware: IMiddleware<C>;
}

Type Parameters

  • C extends Record<string, any> = {}

Properties

config? middleware -

Properties

Optionalconfig

config?: C

middleware

middleware: IMiddleware<C>

Settings

Member Visibility

On This Page

Properties

Interface IMiddlewareExecutionInput

interface IMiddlewareExecutionInput {
    config?: any;
    input?: any;
    next: ((taskInputOrResourceConfig?: any) => Promise<any>);
    resourceDefinition?: IResource<void, any, any>;
    taskDefinition?: ITask<any, any, {}, null>;
}

Properties

config? +

Interface IMiddlewareExecutionInput

interface IMiddlewareExecutionInput {
    config?: any;
    input?: any;
    next: ((taskInputOrResourceConfig?: any) => Promise<any>);
    resourceDefinition?: IResource<void, any, any>;
    taskDefinition?: ITask<any, any, {}, null>;
}

Properties

config? input? next resourceDefinition? taskDefinition? -

Properties

Optionalconfig

config?: any

Optionalinput

input?: any

next

next: ((taskInputOrResourceConfig?: any) => Promise<any>)

OptionalresourceDefinition

resourceDefinition?: IResource<void, any, any>

OptionaltaskDefinition

taskDefinition?: ITask<any, any, {}, null>

Settings

Member Visibility

On This Page

Properties

Interface IMiddlewareMeta

interface IMiddlewareMeta {
    description?: string;
    tags?: string[];
    title?: string;
}

Hierarchy (view full)

Properties

description? +

Interface IMiddlewareMeta

interface IMiddlewareMeta {
    description?: string;
    tags?: string[];
    title?: string;
}

Hierarchy (view full)

Properties

description? tags? title? -

Properties

Optionaldescription

description?: string

Optionaltags

tags?: string[]

Optionaltitle

title?: string

Settings

Member Visibility

On This Page

Properties

Interface IResource<TConfig, TValue, TDependencies>

interface IResource<TConfig, TValue, TDependencies> {
    dependencies?: TDependencies | ((config: TConfig) => TDependencies);
    dispose?: ((value: TValue, config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>);
    events: {
        afterInit: IEventDefinition<AfterInitEventPayload<TConfig, TValue>>;
        beforeInit: IEventDefinition<BeforeInitEventPayload<TConfig>>;
        onError: IEventDefinition<OnErrorEventPayload>;
    };
    hooks: IHookDefinition<TDependencies, any, false>[] | ((config: TConfig) => IHookDefinition<TDependencies, any, false>[]);
    id: string;
    init?: ((config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>);
    meta?: IResourceMeta;
    middleware: IMiddlewareDefinition<any>[];
    overrides: (
        | IResource<void, any, any>
        | ITask<any, any, {}, null>
        | IMiddleware<any>
        | IResourceWithConfig<any, any, any>)[];
    register: RegisterableItems[] | ((config: TConfig) => RegisterableItems[]);
    with(config: TConfig): IResourceWithConfig<TConfig, TValue, TDependencies>;
}

Type Parameters

Hierarchy (view full)

Properties

dependencies? +

Interface IResource<TConfig, TValue, TDependencies>

interface IResource<TConfig, TValue, TDependencies> {
    dependencies?: TDependencies | ((config: TConfig) => TDependencies);
    dispose?: ((value: TValue, config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>);
    events: {
        afterInit: IEventDefinition<AfterInitEventPayload<TConfig, TValue>>;
        beforeInit: IEventDefinition<BeforeInitEventPayload<TConfig>>;
        onError: IEventDefinition<OnErrorEventPayload>;
    };
    hooks: IHookDefinition<TDependencies, any, false>[] | ((config: TConfig) => IHookDefinition<TDependencies, any, false>[]);
    id: string;
    init?: ((config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>);
    meta?: IResourceMeta;
    middleware: IMiddlewareDefinition<any>[];
    overrides: (
        | IResource<void, any, any>
        | ITask<any, any, {}, null>
        | IMiddleware<any>
        | IResourceWithConfig<any, any, any>)[];
    register: RegisterableItems[] | ((config: TConfig) => RegisterableItems[]);
    with(config: TConfig): IResourceWithConfig<TConfig, TValue, TDependencies>;
}

Type Parameters

Hierarchy (view full)

Properties

dependencies? dispose? events hooks @@ -167,12 +167,12 @@ overrides register

Methods

with -

Properties

Optionaldependencies

dependencies?: TDependencies | ((config: TConfig) => TDependencies)

Optionaldispose

dispose?: ((value: TValue, config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>)

Clean-up function for the resource. This is called when the resource is no longer needed.

+

Properties

Optionaldependencies

dependencies?: TDependencies | ((config: TConfig) => TDependencies)

Optionaldispose

dispose?: ((value: TValue, config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>)

Clean-up function for the resource. This is called when the resource is no longer needed.

Type declaration

events

events: {
    afterInit: IEventDefinition<AfterInitEventPayload<TConfig, TValue>>;
    beforeInit: IEventDefinition<BeforeInitEventPayload<TConfig>>;
    onError: IEventDefinition<OnErrorEventPayload>;
}

These events are automatically populated after the task has been defined.

-

hooks

hooks: IHookDefinition<TDependencies, any, false>[] | ((config: TConfig) => IHookDefinition<TDependencies, any, false>[])

id

id: string

Optionalinit

init?: ((config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>)

Optionalmeta

meta?: IResourceMeta

middleware

middleware: IMiddlewareDefinition<any>[]

overrides

overrides: (
    | IResource<void, any, any>
    | ITask<any, any, {}, null>
    | IMiddleware<any>
    | IResourceWithConfig<any, any, any>)[]

register

register: RegisterableItems[] | ((config: TConfig) => RegisterableItems[])

Methods

with

Settings

Member Visibility

On This Page

Properties
Methods

Interface IResourceDefinintion<TConfig, TValue, TDependencies, THooks, TRegisterableItems>

interface IResourceDefinintion<TConfig, TValue, TDependencies, THooks, TRegisterableItems> {
    dependencies?: TDependencies | ((config: TConfig) => TDependencies);
    dispose?: ((value: TValue, config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>);
    hooks?: IHookDefinition<TDependencies, THooks, false>[] | ((config: TConfig) => IHookDefinition<TDependencies, THooks, false>[]);
    id: string;
    init?: ((config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>);
    meta?: IResourceMeta;
    middleware?: IMiddlewareDefinition<any>[];
    overrides?: (
        | IResource<void, any, any>
        | ITask<any, any, {}, null>
        | IMiddleware<any>
        | IResourceWithConfig<any, any, any>)[];
    register?: RegisterableItems[] | ((config: TConfig) => RegisterableItems[]);
}

Type Parameters

  • TConfig = any
  • TValue = unknown
  • TDependencies extends DependencyMapType = {}
  • THooks = any
  • TRegisterableItems = any

Hierarchy (view full)

Properties

dependencies? +

Interface IResourceDefinintion<TConfig, TValue, TDependencies, THooks, TRegisterableItems>

interface IResourceDefinintion<TConfig, TValue, TDependencies, THooks, TRegisterableItems> {
    dependencies?: TDependencies | ((config: TConfig) => TDependencies);
    dispose?: ((value: TValue, config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>);
    hooks?: IHookDefinition<TDependencies, THooks, false>[] | ((config: TConfig) => IHookDefinition<TDependencies, THooks, false>[]);
    id: string;
    init?: ((config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>);
    meta?: IResourceMeta;
    middleware?: IMiddlewareDefinition<any>[];
    overrides?: (
        | IResource<void, any, any>
        | ITask<any, any, {}, null>
        | IMiddleware<any>
        | IResourceWithConfig<any, any, any>)[];
    register?: RegisterableItems[] | ((config: TConfig) => RegisterableItems[]);
}

Type Parameters

  • TConfig = any
  • TValue = unknown
  • TDependencies extends DependencyMapType = {}
  • THooks = any
  • TRegisterableItems = any

Hierarchy (view full)

Properties

dependencies? dispose? hooks? id @@ -165,11 +165,11 @@ middleware? overrides? register? -

Properties

Optionaldependencies

dependencies?: TDependencies | ((config: TConfig) => TDependencies)

Optionaldispose

dispose?: ((value: TValue, config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>)

Clean-up function for the resource. This is called when the resource is no longer needed.

+

Properties

Optionaldependencies

dependencies?: TDependencies | ((config: TConfig) => TDependencies)

Optionaldispose

dispose?: ((value: TValue, config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>)

Clean-up function for the resource. This is called when the resource is no longer needed.

Type declaration

Optionalhooks

hooks?: IHookDefinition<TDependencies, THooks, false>[] | ((config: TConfig) => IHookDefinition<TDependencies, THooks, false>[])

id

id: string

Optionalinit

init?: ((config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>)

Optionalmeta

meta?: IResourceMeta

Optionalmiddleware

middleware?: IMiddlewareDefinition<any>[]

Optionaloverrides

overrides?: (
    | IResource<void, any, any>
    | ITask<any, any, {}, null>
    | IMiddleware<any>
    | IResourceWithConfig<any, any, any>)[]

Optionalregister

register?: RegisterableItems[] | ((config: TConfig) => RegisterableItems[])

Settings

Member Visibility

On This Page

Properties

Interface IResourceMeta

interface IResourceMeta {
    description?: string;
    tags?: string[];
    title?: string;
}

Hierarchy (view full)

Properties

description? +

Interface IResourceMeta

interface IResourceMeta {
    description?: string;
    tags?: string[];
    title?: string;
}

Hierarchy (view full)

Properties

description? tags? title? -

Properties

Optionaldescription

description?: string

Optionaltags

tags?: string[]

Optionaltitle

title?: string

Settings

Member Visibility

On This Page

Properties

Interface IResourceWithConfig<TConfig, TValue, TDependencies>

interface IResourceWithConfig<TConfig, TValue, TDependencies> {
    config: TConfig;
    resource: IResource<TConfig, TValue, TDependencies>;
}

Type Parameters

Properties

config +

Interface IResourceWithConfig<TConfig, TValue, TDependencies>

interface IResourceWithConfig<TConfig, TValue, TDependencies> {
    config: TConfig;
    resource: IResource<TConfig, TValue, TDependencies>;
}

Type Parameters

Properties

config resource -

Properties

config

config: TConfig

resource

resource: IResource<TConfig, TValue, TDependencies>

Settings

Member Visibility

On This Page

Properties

Interface ITask<TInput, TOutput, TDependencies, TEventDefinitionInput>

This is the response after the definition has been prepared. TODO: better naming?

-
interface ITask<TInput, TOutput, TDependencies, TEventDefinitionInput> {
    computedDependencies?: DependencyValuesType<TDependencies>;
    dependencies: TDependencies | (() => TDependencies);
    events: {
        afterRun: IEventDefinition<AfterRunEventPayload<TInput, TOutput>>;
        beforeRun: IEventDefinition<BeforeRunEventPayload<TInput>>;
        onError: IEventDefinition<OnErrorEventPayload>;
    };
    id: string;
    listenerOrder?: number;
    meta?: ITaskMeta;
    middleware: IMiddlewareDefinition<any>[];
    on?: IEventDefinition<TEventDefinitionInput>;
    run: ((input: TEventDefinitionInput extends null
        ? TInput
        : TEventDefinitionInput, dependencies: DependencyValuesType<TDependencies>) => TOutput);
}

Type Parameters

  • TInput = any
  • TOutput extends Promise<any> = any
  • TDependencies extends DependencyMapType = {}
  • TEventDefinitionInput = null

Hierarchy (view full)

Properties

computedDependencies? +
interface ITask<TInput, TOutput, TDependencies, TEventDefinitionInput> {
    computedDependencies?: DependencyValuesType<TDependencies>;
    dependencies: TDependencies | (() => TDependencies);
    events: {
        afterRun: IEventDefinition<AfterRunEventPayload<TInput, TOutput>>;
        beforeRun: IEventDefinition<BeforeRunEventPayload<TInput>>;
        onError: IEventDefinition<OnErrorEventPayload>;
    };
    id: string;
    listenerOrder?: number;
    meta?: ITaskMeta;
    middleware: IMiddlewareDefinition<any>[];
    on?: IEventDefinition<TEventDefinitionInput>;
    run: ((input: TEventDefinitionInput extends null
        ? TInput
        : TEventDefinitionInput, dependencies: DependencyValuesType<TDependencies>) => TOutput);
}

Type Parameters

  • TInput = any
  • TOutput extends Promise<any> = any
  • TDependencies extends DependencyMapType = {}
  • TEventDefinitionInput = null

Hierarchy (view full)

Properties

computedDependencies? dependencies events id @@ -166,11 +166,11 @@ middleware on? run -

Properties

OptionalcomputedDependencies

computedDependencies?: DependencyValuesType<TDependencies>

dependencies

dependencies: TDependencies | (() => TDependencies)

events

events: {
    afterRun: IEventDefinition<AfterRunEventPayload<TInput, TOutput>>;
    beforeRun: IEventDefinition<BeforeRunEventPayload<TInput>>;
    onError: IEventDefinition<OnErrorEventPayload>;
}

These events are automatically populated after the task has been defined.

-

id

id: string

OptionallistenerOrder

listenerOrder?: number

This makes sense only when on is specified to provide the order of the execution. +

Properties

OptionalcomputedDependencies

computedDependencies?: DependencyValuesType<TDependencies>

dependencies

dependencies: TDependencies | (() => TDependencies)

events

events: {
    afterRun: IEventDefinition<AfterRunEventPayload<TInput, TOutput>>;
    beforeRun: IEventDefinition<BeforeRunEventPayload<TInput>>;
    onError: IEventDefinition<OnErrorEventPayload>;
}

These events are automatically populated after the task has been defined.

+

id

id: string

OptionallistenerOrder

listenerOrder?: number

This makes sense only when on is specified to provide the order of the execution. The event with the lowest order will be executed first.

-

Optionalmeta

meta?: ITaskMeta

middleware

middleware: IMiddlewareDefinition<any>[]

Optionalon

on?: IEventDefinition<TEventDefinitionInput>

Listen to events in a simple way

-

run

run: ((input: TEventDefinitionInput extends null
    ? TInput
    : TEventDefinitionInput, dependencies: DependencyValuesType<TDependencies>) => TOutput)

Settings

Member Visibility

On This Page

Properties

Interface ITaskDefinition<TInput, TOutput, TDependencies, TEventDefinitionInput>

interface ITaskDefinition<TInput, TOutput, TDependencies, TEventDefinitionInput> {
    dependencies?: TDependencies | (() => TDependencies);
    id: string;
    listenerOrder?: number;
    meta?: ITaskMeta;
    middleware?: IMiddlewareDefinition<any>[];
    on?: IEventDefinition<TEventDefinitionInput>;
    run: ((input: TEventDefinitionInput extends null
        ? TInput
        : TEventDefinitionInput, dependencies: DependencyValuesType<TDependencies>) => TOutput);
}

Type Parameters

  • TInput = any
  • TOutput extends Promise<any> = any
  • TDependencies extends DependencyMapType = {}
  • TEventDefinitionInput = null

Hierarchy (view full)

Properties

dependencies? +

Interface ITaskDefinition<TInput, TOutput, TDependencies, TEventDefinitionInput>

interface ITaskDefinition<TInput, TOutput, TDependencies, TEventDefinitionInput> {
    dependencies?: TDependencies | (() => TDependencies);
    id: string;
    listenerOrder?: number;
    meta?: ITaskMeta;
    middleware?: IMiddlewareDefinition<any>[];
    on?: IEventDefinition<TEventDefinitionInput>;
    run: ((input: TEventDefinitionInput extends null
        ? TInput
        : TEventDefinitionInput, dependencies: DependencyValuesType<TDependencies>) => TOutput);
}

Type Parameters

  • TInput = any
  • TOutput extends Promise<any> = any
  • TDependencies extends DependencyMapType = {}
  • TEventDefinitionInput = null

Hierarchy (view full)

Properties

dependencies? id listenerOrder? meta? middleware? on? run -

Properties

Optionaldependencies

dependencies?: TDependencies | (() => TDependencies)

id

id: string

OptionallistenerOrder

listenerOrder?: number

This makes sense only when on is specified to provide the order of the execution. +

Properties

Optionaldependencies

dependencies?: TDependencies | (() => TDependencies)

id

id: string

OptionallistenerOrder

listenerOrder?: number

This makes sense only when on is specified to provide the order of the execution. The event with the lowest order will be executed first.

-

Optionalmeta

meta?: ITaskMeta

Optionalmiddleware

middleware?: IMiddlewareDefinition<any>[]

Optionalon

on?: IEventDefinition<TEventDefinitionInput>

Listen to events in a simple way

-

run

run: ((input: TEventDefinitionInput extends null
    ? TInput
    : TEventDefinitionInput, dependencies: DependencyValuesType<TDependencies>) => TOutput)

Settings

Member Visibility

On This Page

Properties

Interface ITaskMeta

interface ITaskMeta {
    description?: string;
    tags?: string[];
    title?: string;
}

Hierarchy (view full)

Properties

description? +

Interface ITaskMeta

interface ITaskMeta {
    description?: string;
    tags?: string[];
    title?: string;
}

Hierarchy (view full)

Properties

description? tags? title? -

Properties

Optionaldescription

description?: string

Optionaltags

tags?: string[]

Optionaltitle

title?: string

Settings

Member Visibility

On This Page

Properties

Namespace definitions

Index

Interfaces

IEvent +

Namespace definitions

Index

Interfaces

IEvent IEventDefinition IEventMeta IHookDefinition diff --git a/docs/types/definitions.AfterInitEventPayload.html b/docs/types/definitions.AfterInitEventPayload.html index 26cdaeb..7401e30 100644 --- a/docs/types/definitions.AfterInitEventPayload.html +++ b/docs/types/definitions.AfterInitEventPayload.html @@ -156,7 +156,7 @@ --md-sys-color-surface-container-high: #e7e8ea; --md-sys-color-surface-container-highest: #e1e3e4 } -

Type Alias AfterInitEventPayload<TConfig, TValue>

AfterInitEventPayload<TConfig, TValue>: {
    config: TConfig;
    value: TValue;
}

Type Parameters

  • TConfig
  • TValue

Settings

Member Visibility

Type Alias AfterInitEventPayload<TConfig, TValue>

AfterInitEventPayload<TConfig, TValue>: {
    config: TConfig;
    value: TValue;
}

Type Parameters

  • TConfig
  • TValue

Settings

Member Visibility

Type Alias AfterRunEventPayload<TInput, TOutput>

AfterRunEventPayload<TInput, TOutput>: {
    input: TInput;
    output: TOutput;
}

Type Parameters

  • TInput
  • TOutput

Settings

Member Visibility

Type Alias AfterRunEventPayload<TInput, TOutput>

AfterRunEventPayload<TInput, TOutput>: {
    input: TInput;
    output: TOutput;
}

Type Parameters

  • TInput
  • TOutput

Settings

Member Visibility

Type Alias BeforeInitEventPayload<TConfig>

BeforeInitEventPayload<TConfig>: {
    config: TConfig;
}

Type Parameters

  • TConfig

Settings

Member Visibility

Type Alias BeforeInitEventPayload<TConfig>

BeforeInitEventPayload<TConfig>: {
    config: TConfig;
}

Type Parameters

  • TConfig

Settings

Member Visibility

Type Alias BeforeRunEventPayload<TInput>

BeforeRunEventPayload<TInput>: {
    input: TInput;
}

Type Parameters

  • TInput

Settings

Member Visibility

Type Alias BeforeRunEventPayload<TInput>

BeforeRunEventPayload<TInput>: {
    input: TInput;
}

Type Parameters

  • TInput

Settings

Member Visibility

Type Alias DependencyMapType

DependencyMapType: Record<string,
    | ITask
    | IResource
    | IEventDefinition
    | IResourceWithConfig<any, any>>

Settings

Member Visibility

Type Alias DependencyMapType

DependencyMapType: Record<string,
    | ITask
    | IResource
    | IEventDefinition
    | IResourceWithConfig<any, any>>

Settings

Member Visibility

Type Alias DependencyValueType<T>

DependencyValueType<T>: T extends ITask<any, any, any>
    ? TaskDependency<ExtractTaskInput<T>, ExtractTaskOutput<T>>
    : T extends IResource<any, any>
        ? ResourceDependency<ExtractResourceValue<T>>
        : T extends IEventDefinition<any>
            ? EventDependency<ExtractEventParams<T>>
            : never

Type Parameters

  • T

Settings

Member Visibility

Type Alias DependencyValueType<T>

DependencyValueType<T>: T extends ITask<any, any, any>
    ? TaskDependency<ExtractTaskInput<T>, ExtractTaskOutput<T>>
    : T extends IResource<any, any>
        ? ResourceDependency<ExtractResourceValue<T>>
        : T extends IEventDefinition<any>
            ? EventDependency<ExtractEventParams<T>>
            : never

Type Parameters

  • T

Settings

Member Visibility

Type Alias DependencyValuesType<T>

DependencyValuesType<T>: {
    [K in keyof T]: DependencyValueType<T[K]>
}

Type Parameters

Settings

Member Visibility

Type Alias DependencyValuesType<T>

DependencyValuesType<T>: {
    [K in keyof T]: DependencyValueType<T[K]>
}

Type Parameters

Settings

Member Visibility

Type Alias EventHandlerType<T>

EventHandlerType<T>: ((event: IEvent<T>) => any | Promise<any>)

Type Parameters

  • T = any

Settings

Member Visibility

Type Alias EventHandlerType<T>

EventHandlerType<T>: ((event: IEvent<T>) => any | Promise<any>)

Type Parameters

  • T = any

Settings

Member Visibility

Type Alias OnErrorEventPayload

OnErrorEventPayload: {
    error: any;
    suppress(): void;
}

Type declaration

  • error: any
  • suppress:function
    • suppress(): void

    • This function can be called to suppress the error from being thrown.

      -

      Returns void

Settings

Member Visibility

Type Alias RegisterableItems

RegisterableItems:
    | IResourceWithConfig<any>
    | IResource<any>
    | ITaskDefinition
    | IMiddlewareDefinition
    | IEventDefinition

Settings

Member Visibility

Type Alias RegisterableItems

RegisterableItems:
    | IResourceWithConfig<any>
    | IResource<any>
    | ITaskDefinition
    | IMiddlewareDefinition
    | IEventDefinition

Settings

Member Visibility

Variable symbolsConst

symbols: {
    event: symbol;
    middleware: symbol;
    middlewareGlobal: symbol;
    resource: symbol;
    resourceWithConfig: symbol;
    task: symbol;
} = ...

Settings

Member Visibility

Variable symbolsConst

symbols: {
    event: symbol;
    middleware: symbol;
    middlewareGlobal: symbol;
    resource: symbol;
    resourceWithConfig: symbol;
    task: symbol;
} = ...

Settings

Member Visibility

Variable globalsConst

globals: {
    events: {
        afterInit: IEventDefinition<any>;
        beforeInit: IEventDefinition<any>;
        log: IEventDefinition<ILog>;
        resources: {
            afterInit: IEventDefinition<{
                config: any;
                resource: IResource<any, any, any>;
                value: any;
            }>;
            beforeInit: IEventDefinition<{
                config: any;
                resource: IResource<any, any, any>;
            }>;
            onError: IEventDefinition<{
                error: Error;
                resource: IResource<any, any, any>;
                suppress: (() => void);
            }>;
        };
        tasks: {
            afterRun: IEventDefinition<{
                input: any;
                output: any;
                task: ITask<any, any, any, null>;
            }>;
            beforeRun: IEventDefinition<{
                input: any;
                task: ITask<any, any, any, null>;
            }>;
            onError: IEventDefinition<{
                error: any;
                suppress: (() => void);
                task: ITask<any, any, any, null>;
            }>;
        };
    };
    resources: {
        eventManager: IResource<EventManager, EventManager, {}>;
        logger: IResource<Logger, Logger, {}>;
        store: IResource<Store, Store, {}>;
        taskRunner: IResource<TaskRunner, TaskRunner, {}>;
    };
} = ...

Settings

Member Visibility

Variable globalsConst

globals: {
    events: {
        afterInit: IEventDefinition<any>;
        beforeInit: IEventDefinition<any>;
        log: IEventDefinition<ILog>;
        resources: {
            afterInit: IEventDefinition<{
                config: any;
                resource: IResource<any, any, any>;
                value: any;
            }>;
            beforeInit: IEventDefinition<{
                config: any;
                resource: IResource<any, any, any>;
            }>;
            onError: IEventDefinition<{
                error: Error;
                resource: IResource<any, any, any>;
                suppress: (() => void);
            }>;
        };
        tasks: {
            afterRun: IEventDefinition<{
                input: any;
                output: any;
                task: ITask<any, any, any, null>;
            }>;
            beforeRun: IEventDefinition<{
                input: any;
                task: ITask<any, any, any, null>;
            }>;
            onError: IEventDefinition<{
                error: any;
                suppress: (() => void);
                task: ITask<any, any, any, null>;
            }>;
        };
    };
    resources: {
        eventManager: IResource<EventManager, EventManager, {}>;
        logger: IResource<Logger, Logger, {}>;
        store: IResource<Store, Store, {}>;
        taskRunner: IResource<TaskRunner, TaskRunner, {}>;
    };
} = ...

Settings

Member Visibility