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>[] | ((config: TConfig) => IHookDefinition<TDependencies>[]);
    id: string;
    init?: ((config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>);
    meta?: IResourceMeta;
    register: RegisterableItems[] | ((config: TConfig) => RegisterableItems[]);
    with(config: TConfig): IResourceWithConfig<TConfig, TValue, TDependencies>;
}

Type Parameters

TConfig = void
TValue = any
TDependencies extends DependencyMapType = any

Hierarchy (view full)

IResourceDefinintion<TConfig, TValue, TDependencies>
- IResource

Index

Properties

dependencies? dispose? events hooks id init? meta? register

Methods

Properties

`Optional`dependencies

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

`Optional`dispose

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

- (value, config, dependencies): Promise<TValue>
- Parameters
  - value: TValue
    The value of the resource
  - config: TConfig
    The configuration it received
  - dependencies: DependencyValuesType<TDependencies>
    The dependencies it needed
  Returns Promise<TValue>

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>[] | ((config: TConfig) => IHookDefinition<TDependencies>[])

id

id: string

`Optional`init

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

`Optional`meta

meta?: IResourceMeta

register

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

Methods

with

with(config): IResourceWithConfig<TConfig, TValue, TDependencies>
Parameters
- config: TConfig
Returns IResourceWithConfig<TConfig, TValue, TDependencies>
- Defined in defs.ts:156