Interface IResourceDefinintion<TConfig, TValue, TDependencies>

interface IResourceDefinintion<TConfig, TValue, TDependencies> {
    dependencies?: TDependencies | ((config: TConfig) => TDependencies);
    dispose?: ((value: TValue, config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>);
    hooks?: IHookDefinition<TDependencies>[] | ((config: TConfig) => IHookDefinition<TDependencies>[]);
    id: string;
    init?: ((config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>);
    meta?: IResourceMeta;
    register?: RegisterableItems[] | ((config: TConfig) => RegisterableItems[]);
}

Type Parameters

Hierarchy (view full)

Properties

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

Optionalhooks

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

id

id: string

Optionalinit

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

Optionalmeta

meta?: IResourceMeta

Optionalregister

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

Settings

Member Visibility

On This Page

Properties