embarklabs
/
embark
mirror of https://github.com/embarklabs/embark.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

fix(@embark/core): ensure type declaration for Plugin.registerActionForEvent() is legit 

In 776db1b7f7 (diff-5cab125016e6d753f03b6cd0241d5ebbR267) we've introduced the ability to add
a `priority` parameter to plugin actions, so the order of actions can be semi-ensured.

That commit also introduced typings for that new API but it actually didn't match the
implementation of the API, namely that the second parameter of `Plugin.registerActionForEvent()`
can be either an options object **or** a callback function.

This forces consumers to call the API as `registerActoniForEvent(name, undefined|null, callback)`
which shouldn't be necessary.
This commit is contained in:
Pascal Precht 2019-11-18 11:14:36 +01:00 committed by Pascal Precht
parent 978e17daa1
commit 5dc4b2134e
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
packages/core/typings/src/embark.d.ts vendored
View File

@ -1,5 +1,6 @@
import { Logger } from './logger'; import { Logger } from './logger';
import { Plugins } from './plugins'; import { Plugins } from './plugins';
import { Callback } from './callbacks';
type CommandCallback = ( type CommandCallback = (
opt1?: any, opt1?: any,
@ -63,6 +64,8 @@ export interface Config {
reloadConfig(): void; reloadConfig(): void;
} }
type ActionCallback<T> = (params: any, cb: Callback<T>) => void;
export interface Embark { export interface Embark {
env: string; env: string;
events: Events; events: Events;
@ -73,8 +76,9 @@ export interface Embark {
fs: any; fs: any;
config: Config; config: Config;
currentContext: string[]; currentContext: string[];
registerActionForEvent( registerActionForEvent<T>(
name: string, name: string,
action: (params: any, cb: (error: any, result: any) => void) => void, options?: ActionCallback<T> | { priority: number },
action?: ActionCallback<T>,
): void; ): void;
} }