Interface: ILoaderStrategy<T>
An abstracted loader strategy interface.
Type parameters
Name | Type |
---|---|
T | extends Piece |
Implemented by
Methods
filter
▸ filter(path
): FilterResult
Retrieves the name and the extension of the specified file path.
Example
// ts-node support
class MyStrategy extends LoaderStrategy {
filter(path) {
const extension = extname(path);
if (!['.js', '.ts'].includes(extension)) return null;
const name = basename(path, extension);
return { extension, name };
}
}
Parameters
Name | Type | Description |
---|---|---|
path | string | The path of the file to be processed. |
Returns
A ModuleData on success, otherwise null
to stop the store from processing the path.
Defined in
projects/pieces/src/lib/strategies/ILoaderStrategy.ts:81
load
▸ load(store
, file
): ILoaderResult
<T
>
The load hook, use this to override the loader.
Example
class MyStrategy extends LoaderStrategy {
load(store, file) {
// ...
}
}
Parameters
Name | Type |
---|---|
store | Store <T > |
file | HydratedModuleData |
Returns
Defined in
projects/pieces/src/lib/strategies/ILoaderStrategy.ts:117
onError
▸ onError(error
, path
): void
Parameters
Name | Type | Description |
---|---|---|
error | Error | The error that was thrown. |
path | string | The path of the file that caused the error to be thrown. |
Returns
void
Defined in
projects/pieces/src/lib/strategies/ILoaderStrategy.ts:149
onLoad
▸ onLoad(store
, piece
): unknown
Called after a piece has been loaded, but before onLoad and set.
Parameters
Name | Type | Description |
---|---|---|
store | Store <T > | The store that holds the piece. |
piece | T | The piece that was loaded. |
Returns
unknown
Defined in
projects/pieces/src/lib/strategies/ILoaderStrategy.ts:124
onLoadAll
▸ onLoadAll(store
): unknown
Called after all pieces have been loaded.
Parameters
Name | Type | Description |
---|---|---|
store | Store <T > | The store that loaded all pieces. |
Returns
unknown
Defined in
projects/pieces/src/lib/strategies/ILoaderStrategy.ts:130
onUnload
▸ onUnload(store
, piece
): unknown
Called after a piece has been unloaded or overwritten by a newly loaded piece.
Parameters
Name | Type | Description |
---|---|---|
store | Store <T > | The store that held the piece. |
piece | T | The piece that was unloaded. |
Returns
unknown
Defined in
projects/pieces/src/lib/strategies/ILoaderStrategy.ts:137
onUnloadAll
▸ onUnloadAll(store
): unknown
Called after all pieces have been unloaded.
Parameters
Name | Type | Description |
---|---|---|
store | Store <T > | The store that unloaded all pieces. |
Returns
unknown
Defined in
projects/pieces/src/lib/strategies/ILoaderStrategy.ts:143
preload
▸ preload(file
): PreloadResult
<T
>
The pre-load hook, use this to override the loader.
Example
// CommonJS support:
class MyStrategy extends LoaderStrategy {
preload(path) {
return require(path);
}
}
Example
// ESM support:
class MyStrategy extends LoaderStrategy {
preload(file) {
return import(file.path);
}
}
Parameters
Name | Type |
---|---|
file | ModuleData |