hookable 5.2.2 → 5.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/dist/index.cjs +17 -17
  2. package/dist/index.d.ts +6 -3
  3. package/dist/index.mjs +17 -17
  4. package/package.json +1 -1
package/dist/index.cjs CHANGED
@@ -56,34 +56,34 @@ class Hookable {
56
56
  this._hooks = {};
57
57
  this._before = null;
58
58
  this._after = null;
59
+ this._deprecatedMessages = null;
59
60
  this._deprecatedHooks = {};
60
61
  this.hook = this.hook.bind(this);
61
62
  this.callHook = this.callHook.bind(this);
62
63
  this.callHookWith = this.callHookWith.bind(this);
63
64
  }
64
- hook(name, fn) {
65
+ hook(name, fn, opts = {}) {
65
66
  if (!name || typeof fn !== "function") {
66
67
  return () => {
67
68
  };
68
69
  }
69
70
  const originalName = name;
70
- let deprecatedHookObj;
71
+ let dep;
71
72
  while (this._deprecatedHooks[name]) {
72
- const deprecatedHook = this._deprecatedHooks[name];
73
- if (typeof deprecatedHook === "string") {
74
- deprecatedHookObj = { to: deprecatedHook };
75
- } else {
76
- deprecatedHookObj = deprecatedHook;
77
- }
78
- name = deprecatedHookObj.to;
73
+ dep = this._deprecatedHooks[name];
74
+ name = dep.to;
79
75
  }
80
- if (deprecatedHookObj) {
81
- if (!deprecatedHookObj.message) {
82
- console.warn(
83
- `${originalName} hook has been deprecated` + (deprecatedHookObj.to ? `, please use ${deprecatedHookObj.to}` : "")
84
- );
85
- } else {
86
- console.warn(deprecatedHookObj.message);
76
+ if (dep && !opts.allowDeprecated) {
77
+ let message = dep.message;
78
+ if (!message) {
79
+ message = `${originalName} hook has been deprecated` + (dep.to ? `, please use ${dep.to}` : "");
80
+ }
81
+ if (!this._deprecatedMessages) {
82
+ this._deprecatedMessages = /* @__PURE__ */ new Set();
83
+ }
84
+ if (!this._deprecatedMessages.has(message)) {
85
+ console.warn(message);
86
+ this._deprecatedMessages.add(message);
87
87
  }
88
88
  }
89
89
  this._hooks[name] = this._hooks[name] || [];
@@ -118,7 +118,7 @@ class Hookable {
118
118
  }
119
119
  }
120
120
  deprecateHook(name, deprecated) {
121
- this._deprecatedHooks[name] = deprecated;
121
+ this._deprecatedHooks[name] = typeof deprecated === "string" ? { to: deprecated } : deprecated;
122
122
  const _hooks = this._hooks[name] || [];
123
123
  this._hooks[name] = void 0;
124
124
  for (const hook of _hooks) {
package/dist/index.d.ts CHANGED
@@ -3,7 +3,7 @@ interface Hooks {
3
3
  [key: string]: HookCallback;
4
4
  }
5
5
  declare type HookKeys<T> = keyof T & string;
6
- declare type DeprecatedHook<T> = string | {
6
+ declare type DeprecatedHook<T> = {
7
7
  message?: string;
8
8
  to: HookKeys<T>;
9
9
  };
@@ -48,11 +48,14 @@ declare class Hookable<HooksT = Record<string, HookCallback>, HookNameT extends
48
48
  private _before;
49
49
  private _after;
50
50
  private _deprecatedHooks;
51
+ private _deprecatedMessages;
51
52
  constructor();
52
- hook<NameT extends HookNameT>(name: NameT, fn: InferCallback<HooksT, NameT>): () => void;
53
+ hook<NameT extends HookNameT>(name: NameT, fn: InferCallback<HooksT, NameT>, opts?: {
54
+ allowDeprecated?: boolean;
55
+ }): () => void;
53
56
  hookOnce<NameT extends HookNameT>(name: NameT, fn: InferCallback<HooksT, NameT>): () => void;
54
57
  removeHook<NameT extends HookNameT>(name: NameT, fn: InferCallback<HooksT, NameT>): void;
55
- deprecateHook<NameT extends HookNameT>(name: NameT, deprecated: DeprecatedHook<HooksT>): void;
58
+ deprecateHook<NameT extends HookNameT>(name: NameT, deprecated: HookKeys<HooksT> | DeprecatedHook<HooksT>): void;
56
59
  deprecateHooks(deprecatedHooks: Partial<Record<HookNameT, DeprecatedHook<HooksT>>>): void;
57
60
  addHooks(configHooks: NestedHooks<HooksT>): () => void;
58
61
  removeHooks(configHooks: NestedHooks<HooksT>): void;
package/dist/index.mjs CHANGED
@@ -52,34 +52,34 @@ class Hookable {
52
52
  this._hooks = {};
53
53
  this._before = null;
54
54
  this._after = null;
55
+ this._deprecatedMessages = null;
55
56
  this._deprecatedHooks = {};
56
57
  this.hook = this.hook.bind(this);
57
58
  this.callHook = this.callHook.bind(this);
58
59
  this.callHookWith = this.callHookWith.bind(this);
59
60
  }
60
- hook(name, fn) {
61
+ hook(name, fn, opts = {}) {
61
62
  if (!name || typeof fn !== "function") {
62
63
  return () => {
63
64
  };
64
65
  }
65
66
  const originalName = name;
66
- let deprecatedHookObj;
67
+ let dep;
67
68
  while (this._deprecatedHooks[name]) {
68
- const deprecatedHook = this._deprecatedHooks[name];
69
- if (typeof deprecatedHook === "string") {
70
- deprecatedHookObj = { to: deprecatedHook };
71
- } else {
72
- deprecatedHookObj = deprecatedHook;
73
- }
74
- name = deprecatedHookObj.to;
69
+ dep = this._deprecatedHooks[name];
70
+ name = dep.to;
75
71
  }
76
- if (deprecatedHookObj) {
77
- if (!deprecatedHookObj.message) {
78
- console.warn(
79
- `${originalName} hook has been deprecated` + (deprecatedHookObj.to ? `, please use ${deprecatedHookObj.to}` : "")
80
- );
81
- } else {
82
- console.warn(deprecatedHookObj.message);
72
+ if (dep && !opts.allowDeprecated) {
73
+ let message = dep.message;
74
+ if (!message) {
75
+ message = `${originalName} hook has been deprecated` + (dep.to ? `, please use ${dep.to}` : "");
76
+ }
77
+ if (!this._deprecatedMessages) {
78
+ this._deprecatedMessages = /* @__PURE__ */ new Set();
79
+ }
80
+ if (!this._deprecatedMessages.has(message)) {
81
+ console.warn(message);
82
+ this._deprecatedMessages.add(message);
83
83
  }
84
84
  }
85
85
  this._hooks[name] = this._hooks[name] || [];
@@ -114,7 +114,7 @@ class Hookable {
114
114
  }
115
115
  }
116
116
  deprecateHook(name, deprecated) {
117
- this._deprecatedHooks[name] = deprecated;
117
+ this._deprecatedHooks[name] = typeof deprecated === "string" ? { to: deprecated } : deprecated;
118
118
  const _hooks = this._hooks[name] || [];
119
119
  this._hooks[name] = void 0;
120
120
  for (const hook of _hooks) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "hookable",
3
- "version": "5.2.2",
3
+ "version": "5.3.0",
4
4
  "description": "Awaitable hook system",
5
5
  "keywords": [
6
6
  "hook",