Interface IResource<TConfig, TValue, TDependencies, TContext>

interface IResource<TConfig, TValue, TDependencies, TContext> {
    [symbolFilePath]?: string;
    [symbolIndexResource]?: boolean;
    context?: (() => TContext);
    dependencies?: TDependencies | ((config: TConfig) => TDependencies);
    dispose?: ((this: any, value: TValue, config: TConfig, dependencies: DependencyValuesType<TDependencies>, context: TContext) => Promise<void>);
    events: {
        afterInit: IEvent<AfterInitEventPayload<TConfig, TValue>>;
        beforeInit: IEvent<BeforeInitEventPayload<TConfig>>;
        onError: IEvent<OnErrorEventPayload>;
    };
    id: string | symbol;
    init?: ((this: any, config: TConfig, dependencies: DependencyValuesType<TDependencies>, context: TContext) => Promise<TValue>);
    meta?: IResourceMeta;
    middleware: MiddlewareAttachments[];
    overrides: (
        | IMiddleware<any, any>
        | IResource<void, any, any, any>
        | ITask<any, any, {}, undefined>
        | IResourceWithConfig<any, any, any>)[];
    register: RegisterableItems<any>[] | ((config: TConfig) => RegisterableItems<any>[]);
    with(config: TConfig): IResourceWithConfig<TConfig, TValue, TDependencies>;
}

Type Parameters

  • TConfig = void
  • TValue = any
  • TDependencies extends DependencyMapType = any
  • TContext = any

Hierarchy (view full)

Properties

[symbolFilePath]? [symbolIndexResource]? context? dependencies? dispose? events id init? meta? middleware overrides register

Methods

with

Properties

Optional[symbolFilePath]

[symbolFilePath]?: string

This is optional and used from an index resource to get the correct caller.

Optional[symbolIndexResource]

[symbolIndexResource]?: boolean

This is used internally when creating index resources.

Optionalcontext

context?: (() => TContext)

Optionaldependencies

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

Optionaldispose

dispose?: ((this: any, value: TValue, config: TConfig, dependencies: DependencyValuesType<TDependencies>, context: TContext) => Promise<void>)

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

Type declaration

    • (this, value, config, dependencies, context): Promise<void>

    • Parameters

      Returns Promise<void>

      Promise

events

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

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

id

id: string | symbol

Optionalinit

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

Optionalmeta

meta?: IResourceMeta

middleware

middleware: MiddlewareAttachments[]

overrides

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

register

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

Methods

with

Settings

Member Visibility

On This Page

Properties
Methods