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

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

Type Parameters

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

Hierarchy (view full)

Properties

dependencies? dispose? id init? meta? 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.

Type declaration

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, {}, undefined>
    | IMiddleware<any>
    | IResourceWithConfig<any, any, any>)[]

Optionalregister

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

Settings

Member Visibility

On This Page

Properties