@nemigo/helpers 0.6.0 → 0.7.1

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 (6) hide show
  1. package/dist/html.d.ts +11 -7
  2. package/dist/html.js +15 -29
  3. package/dist/index.d.ts +5 -4
  4. package/dist/index.js +20 -3
  5. package/dist/types.d.ts +4 -0
  6. package/package.json +146 -146
package/dist/html.d.ts CHANGED
@@ -8,11 +8,16 @@ export declare const isSSR: boolean;
8
8
  */
9
9
  export declare const preventStop: (e: Event) => void;
10
10
  /**
11
- * Создаёт обработчик события с {@link preventStop}, который выполняется всегда.
12
- * Коллбэк выполняется только, если load вернёт `false` (при его наличии)
11
+ * Создаёт обработчик события с {@link preventStop}, который выполняется всегда, если иное не задано через `usePreventStop`
12
+ * Коллбэк выполняется аналогично, но уже относительно `condition`
13
13
  */
14
- export declare const preventStopHook: <T extends Event = Event>(call?: CanBeNullable<(e: T) => CanBePromise>, load?: () => boolean | undefined) => ((e: T) => void);
14
+ export declare const preventStopHook: <T extends Event = Event>(call?: CanBeNullable<(e: T) => CanBePromise>, { usePreventStop, condition, }?: {
15
+ usePreventStop?: ((e: T) => unknown) | unknown;
16
+ condition?: ((e: T) => unknown) | unknown;
17
+ }) => ((e: T) => void);
15
18
  /**
19
+ * TODO: актуализация JSDoc
20
+ *
16
21
  * Возвращает обработчик клавиатурных событий, который:
17
22
  *
18
23
  * 1. Если `usePreventStop === true`, вызывает {@link preventStop}
@@ -20,10 +25,9 @@ export declare const preventStopHook: <T extends Event = Event>(call?: CanBeNull
20
25
  * 3. Вызывает переданный **prepare-коллбэк** (при его наличии), если он вернёт `false`, то выполнение остановится
21
26
  * 4. Вызывает основной коллбэк только при нажатии `Enter`.
22
27
  */
23
- export declare const enterKeyHook: <T extends KeyboardEvent = KeyboardEvent>(call?: CanBeNullable<(e: T) => CanBePromise>, config?: {
24
- usePreventStop?: "enter" | boolean | ((e: T, isEnter: boolean) => boolean);
25
- prepare?: (e: T) => CanBePromise<boolean>;
26
- load?: () => boolean | undefined;
28
+ export declare const enterKeyHook: <T extends KeyboardEvent = KeyboardEvent>(call?: CanBeNullable<(e: T) => CanBePromise>, { usePreventStop, condition, }?: {
29
+ usePreventStop?: "enter" | unknown | ((e: T, isEnter: boolean) => unknown);
30
+ condition?: ((e: T) => unknown) | unknown;
27
31
  }) => (e: T) => void;
28
32
  /**
29
33
  * Создаёт обработчик событий для указанного элемента или окна
package/dist/html.js CHANGED
@@ -1,3 +1,4 @@
1
+ import { useConditionGuard } from "./index.js";
1
2
  /**
2
3
  * Проверка по глобальному `window`
3
4
  */
@@ -7,16 +8,19 @@ export const isSSR = typeof window === "undefined";
7
8
  */
8
9
  export const preventStop = (e) => (e.preventDefault(), e.stopPropagation());
9
10
  /**
10
- * Создаёт обработчик события с {@link preventStop}, который выполняется всегда.
11
- * Коллбэк выполняется только, если load вернёт `false` (при его наличии)
11
+ * Создаёт обработчик события с {@link preventStop}, который выполняется всегда, если иное не задано через `usePreventStop`
12
+ * Коллбэк выполняется аналогично, но уже относительно `condition`
12
13
  */
13
- export const preventStopHook = (call, load) => (e) => {
14
- preventStop(e);
15
- if (!load || !load())
14
+ export const preventStopHook = (call, { usePreventStop = true, condition = true, } = {}) => (e) => {
15
+ if (useConditionGuard(usePreventStop, e))
16
+ preventStop(e);
17
+ if (useConditionGuard(condition, e))
16
18
  call?.(e);
17
19
  };
18
20
  //...
19
21
  /**
22
+ * TODO: актуализация JSDoc
23
+ *
20
24
  * Возвращает обработчик клавиатурных событий, который:
21
25
  *
22
26
  * 1. Если `usePreventStop === true`, вызывает {@link preventStop}
@@ -24,36 +28,18 @@ export const preventStopHook = (call, load) => (e) => {
24
28
  * 3. Вызывает переданный **prepare-коллбэк** (при его наличии), если он вернёт `false`, то выполнение остановится
25
29
  * 4. Вызывает основной коллбэк только при нажатии `Enter`.
26
30
  */
27
- export const enterKeyHook = (call, config = { usePreventStop: "enter" }) => (e) => {
31
+ export const enterKeyHook = (call, { usePreventStop = "enter", condition = true, } = {}) => (e) => {
28
32
  const isEnter = e.key === "Enter";
29
- if (config.usePreventStop === "enter") {
33
+ if (usePreventStop === "enter") {
30
34
  if (isEnter)
31
35
  preventStop(e);
32
36
  }
33
37
  else {
34
- if (config.usePreventStop !== undefined) {
35
- if (typeof config.usePreventStop === "boolean") {
36
- if (config.usePreventStop)
37
- preventStop(e);
38
- }
39
- else {
40
- if (config.usePreventStop(e, isEnter))
41
- preventStop(e);
42
- }
43
- }
44
- }
45
- if (config.load?.())
46
- return;
47
- if (config.prepare) {
48
- void Promise.resolve(config.prepare(e)).then((next) => {
49
- if (next && isEnter)
50
- call?.(e);
51
- });
52
- }
53
- else {
54
- if (isEnter)
55
- call?.(e);
38
+ if (useConditionGuard(usePreventStop, e, isEnter))
39
+ preventStop(e);
56
40
  }
41
+ if (isEnter && useConditionGuard(condition))
42
+ call?.(e);
57
43
  };
58
44
  //...
59
45
  /**
package/dist/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import type { CanBeArray } from "./types.js";
1
+ import type { CanBeArray, CanBeReadonly } from "./types.js";
2
2
  /**
3
3
  * Добавляет ведущие нули к числу для достижения указанной длины
4
4
  *
@@ -32,11 +32,11 @@ export interface Partition<T> {
32
32
  /**
33
33
  * Разделяет массив на два по условию
34
34
  */
35
- export declare const partition: <T>(arr: T[], filter: (item: T) => boolean, initial?: Partition<T>) => Partition<T>;
35
+ export declare const partition: <T>(arr: CanBeReadonly<T>, filter: (item: T) => boolean, initial?: Partition<T>) => Partition<T>;
36
36
  /**
37
37
  * Удаляет `null` и `undefined` и оставляет только уникальные строки
38
38
  */
39
- export declare const setify: (arr: (string | undefined | null)[]) => string[];
39
+ export declare const setify: (arr: CanBeReadonly<string | undefined | null>) => string[];
40
40
  /**
41
41
  * Удаляет дубликаты объектов из массива на основе указанного ключа
42
42
  *
@@ -46,4 +46,5 @@ export declare const setify: (arr: (string | undefined | null)[]) => string[];
46
46
  * @param {K} [key="id"] - Ключ, по которому будут удаляться дубликаты
47
47
  * @returns {T[]} Новый массив без дубликатов
48
48
  */
49
- export declare const unify: <T, K extends keyof T>(arr: T[], key?: K) => T[];
49
+ export declare const unify: <T, K extends keyof T>(arr: CanBeReadonly<T>, key?: K) => T[];
50
+ export declare const useConditionGuard: (condition: unknown, ...args: any[]) => boolean;
package/dist/index.js CHANGED
@@ -23,12 +23,16 @@ export const isSameType = (a, b) => Object.prototype.toString.call(a) === Object
23
23
  /**
24
24
  * Разделяет массив на два по условию
25
25
  */
26
- export const partition = (arr, filter, initial = { result: [], excluded: [] }) => arr.reduce((acc, item) => (acc[filter(item) ? "result" : "excluded"].push(item), acc), initial);
26
+ export const partition = (arr, filter, initial = { result: [], excluded: [] }) =>
27
+ // @ts-expect-error <оно себя неадекватно ведёт>
28
+ arr.reduce((acc, item) => (acc[filter(item) ? "result" : "excluded"].push(item), acc), initial);
27
29
  //...
28
30
  /**
29
31
  * Удаляет `null` и `undefined` и оставляет только уникальные строки
30
32
  */
31
- export const setify = (arr) => [...new Set(arr.filter((item) => typeof item === "string"))];
33
+ export const setify = (arr) =>
34
+ // @ts-expect-error <оно себя неадекватно ведёт>
35
+ [...new Set(arr.filter((item) => typeof item === "string"))];
32
36
  /**
33
37
  * Удаляет дубликаты объектов из массива на основе указанного ключа
34
38
  *
@@ -38,4 +42,17 @@ export const setify = (arr) => [...new Set(arr.filter((item) => typeof item ===
38
42
  * @param {K} [key="id"] - Ключ, по которому будут удаляться дубликаты
39
43
  * @returns {T[]} Новый массив без дубликатов
40
44
  */
41
- export const unify = (arr, key = "id") => [...new Map(arr.map((item) => [item[key], item])).values()];
45
+ export const unify = (arr, key = "id") =>
46
+ // @ts-expect-error <оно себя неадекватно ведёт>
47
+ [...new Map(arr.map((item) => [item[key], item])).values()];
48
+ //...
49
+ export const useConditionGuard = (condition, ...args) => {
50
+ switch (typeof condition) {
51
+ case "undefined":
52
+ return true;
53
+ case "function":
54
+ return !!condition(...args);
55
+ default:
56
+ return !!condition;
57
+ }
58
+ };
package/dist/types.d.ts CHANGED
@@ -29,6 +29,10 @@ export type CanBeNullable<T = unknown> = T | null | undefined;
29
29
  * Значение может быть массивом или одиночным элементом
30
30
  */
31
31
  export type CanBeArray<T = unknown> = T | T[];
32
+ /**
33
+ * Массив может быть readonly
34
+ */
35
+ export type CanBeReadonly<T = unknown> = readonly T[] | T[];
32
36
  /**
33
37
  * Значение может быть промиссом
34
38
  */
package/package.json CHANGED
@@ -1,146 +1,146 @@
1
- {
2
- "name": "@nemigo/helpers",
3
- "version": "0.6.0",
4
- "private": false,
5
- "author": {
6
- "name": "Vlad Logvin",
7
- "email": "vlad.logvin84@gmail.com"
8
- },
9
- "type": "module",
10
- "scripts": {
11
- "build": "svelte-package && rimraf .svelte-kit",
12
- "check": "tsc --noemit",
13
- "lint": "eslint ./",
14
- "test": "vitest --run",
15
- "format": "prettier --write ./"
16
- },
17
- "exports": {
18
- ".": {
19
- "types": "./dist/index.d.ts",
20
- "default": "./dist/index.js"
21
- },
22
- "./async": {
23
- "types": "./dist/async.d.ts",
24
- "default": "./dist/async.js"
25
- },
26
- "./cases": {
27
- "types": "./dist/cases.d.ts",
28
- "default": "./dist/cases.js"
29
- },
30
- "./clean": {
31
- "types": "./dist/clean.d.ts",
32
- "default": "./dist/clean.js"
33
- },
34
- "./cookie": {
35
- "types": "./dist/cookie.d.ts",
36
- "default": "./dist/cookie.js"
37
- },
38
- "./datetime": {
39
- "types": "./dist/datetime.d.ts",
40
- "default": "./dist/datetime.js"
41
- },
42
- "./emitter": {
43
- "types": "./dist/emitter.d.ts",
44
- "default": "./dist/emitter.js"
45
- },
46
- "./explorer": {
47
- "types": "./dist/explorer.d.ts",
48
- "default": "./dist/explorer.js"
49
- },
50
- "./files": {
51
- "types": "./dist/files.d.ts",
52
- "default": "./dist/files.js"
53
- },
54
- "./format": {
55
- "types": "./dist/format.d.ts",
56
- "default": "./dist/format.js"
57
- },
58
- "./future": {
59
- "types": "./dist/future.d.ts",
60
- "default": "./dist/future.js"
61
- },
62
- "./html": {
63
- "types": "./dist/html.d.ts",
64
- "default": "./dist/html.js"
65
- },
66
- "./humanly": {
67
- "types": "./dist/humanly.d.ts",
68
- "default": "./dist/humanly.js"
69
- },
70
- "./lens": {
71
- "types": "./dist/lens.d.ts",
72
- "default": "./dist/lens.js"
73
- },
74
- "./lru": {
75
- "types": "./dist/lru.d.ts",
76
- "default": "./dist/lru.js"
77
- },
78
- "./msgpack": {
79
- "types": "./dist/msgpack.d.ts",
80
- "default": "./dist/msgpack.js"
81
- },
82
- "./omitter": {
83
- "types": "./dist/omitter.d.ts",
84
- "default": "./dist/omitter.js"
85
- },
86
- "./phymath": {
87
- "types": "./dist/phymath.d.ts",
88
- "default": "./dist/phymath.js"
89
- },
90
- "./phymath/types": {
91
- "types": "./dist/phymath.types.d.ts",
92
- "default": "./dist/phymath.types.js"
93
- },
94
- "./promoter": {
95
- "types": "./dist/promoter.d.ts",
96
- "default": "./dist/promoter.js"
97
- },
98
- "./queue": {
99
- "types": "./dist/queue.d.ts",
100
- "default": "./dist/queue.js"
101
- },
102
- "./random": {
103
- "types": "./dist/random.d.ts",
104
- "default": "./dist/random.js"
105
- },
106
- "./script": {
107
- "types": "./dist/script.d.ts",
108
- "default": "./dist/script.js"
109
- },
110
- "./string": {
111
- "types": "./dist/string.d.ts",
112
- "default": "./dist/string.js"
113
- },
114
- "./types": {
115
- "types": "./dist/types.d.ts",
116
- "default": "./dist/types.js"
117
- },
118
- "./url": {
119
- "types": "./dist/url.d.ts",
120
- "default": "./dist/url.js"
121
- },
122
- "./xod": {
123
- "types": "./dist/xod.d.ts",
124
- "default": "./dist/xod.js"
125
- },
126
- "./zipper": {
127
- "types": "./dist/zipper.d.ts",
128
- "default": "./dist/zipper.js"
129
- }
130
- },
131
- "peerDependencies": {
132
- "zod": "^4.0.0"
133
- },
134
- "peerDependenciesMeta": {
135
- "zod": {
136
- "optional": true
137
- }
138
- },
139
- "dependencies": {
140
- "@std/msgpack": "jsr:^1.0.0"
141
- },
142
- "devDependencies": {
143
- "@nemigo/configs": "workspace:*",
144
- "zod": "4.1.5"
145
- }
146
- }
1
+ {
2
+ "name": "@nemigo/helpers",
3
+ "version": "0.7.1",
4
+ "private": false,
5
+ "author": {
6
+ "name": "Vlad Logvin",
7
+ "email": "vlad.logvin84@gmail.com"
8
+ },
9
+ "type": "module",
10
+ "scripts": {
11
+ "build": "svelte-package && rimraf .svelte-kit",
12
+ "check": "tsc --noemit",
13
+ "lint": "eslint ./",
14
+ "test": "vitest --run",
15
+ "format": "prettier --write ./"
16
+ },
17
+ "exports": {
18
+ ".": {
19
+ "types": "./dist/index.d.ts",
20
+ "default": "./dist/index.js"
21
+ },
22
+ "./async": {
23
+ "types": "./dist/async.d.ts",
24
+ "default": "./dist/async.js"
25
+ },
26
+ "./cases": {
27
+ "types": "./dist/cases.d.ts",
28
+ "default": "./dist/cases.js"
29
+ },
30
+ "./clean": {
31
+ "types": "./dist/clean.d.ts",
32
+ "default": "./dist/clean.js"
33
+ },
34
+ "./cookie": {
35
+ "types": "./dist/cookie.d.ts",
36
+ "default": "./dist/cookie.js"
37
+ },
38
+ "./datetime": {
39
+ "types": "./dist/datetime.d.ts",
40
+ "default": "./dist/datetime.js"
41
+ },
42
+ "./emitter": {
43
+ "types": "./dist/emitter.d.ts",
44
+ "default": "./dist/emitter.js"
45
+ },
46
+ "./explorer": {
47
+ "types": "./dist/explorer.d.ts",
48
+ "default": "./dist/explorer.js"
49
+ },
50
+ "./files": {
51
+ "types": "./dist/files.d.ts",
52
+ "default": "./dist/files.js"
53
+ },
54
+ "./format": {
55
+ "types": "./dist/format.d.ts",
56
+ "default": "./dist/format.js"
57
+ },
58
+ "./future": {
59
+ "types": "./dist/future.d.ts",
60
+ "default": "./dist/future.js"
61
+ },
62
+ "./html": {
63
+ "types": "./dist/html.d.ts",
64
+ "default": "./dist/html.js"
65
+ },
66
+ "./humanly": {
67
+ "types": "./dist/humanly.d.ts",
68
+ "default": "./dist/humanly.js"
69
+ },
70
+ "./lens": {
71
+ "types": "./dist/lens.d.ts",
72
+ "default": "./dist/lens.js"
73
+ },
74
+ "./lru": {
75
+ "types": "./dist/lru.d.ts",
76
+ "default": "./dist/lru.js"
77
+ },
78
+ "./msgpack": {
79
+ "types": "./dist/msgpack.d.ts",
80
+ "default": "./dist/msgpack.js"
81
+ },
82
+ "./omitter": {
83
+ "types": "./dist/omitter.d.ts",
84
+ "default": "./dist/omitter.js"
85
+ },
86
+ "./phymath": {
87
+ "types": "./dist/phymath.d.ts",
88
+ "default": "./dist/phymath.js"
89
+ },
90
+ "./phymath/types": {
91
+ "types": "./dist/phymath.types.d.ts",
92
+ "default": "./dist/phymath.types.js"
93
+ },
94
+ "./promoter": {
95
+ "types": "./dist/promoter.d.ts",
96
+ "default": "./dist/promoter.js"
97
+ },
98
+ "./queue": {
99
+ "types": "./dist/queue.d.ts",
100
+ "default": "./dist/queue.js"
101
+ },
102
+ "./random": {
103
+ "types": "./dist/random.d.ts",
104
+ "default": "./dist/random.js"
105
+ },
106
+ "./script": {
107
+ "types": "./dist/script.d.ts",
108
+ "default": "./dist/script.js"
109
+ },
110
+ "./string": {
111
+ "types": "./dist/string.d.ts",
112
+ "default": "./dist/string.js"
113
+ },
114
+ "./types": {
115
+ "types": "./dist/types.d.ts",
116
+ "default": "./dist/types.js"
117
+ },
118
+ "./url": {
119
+ "types": "./dist/url.d.ts",
120
+ "default": "./dist/url.js"
121
+ },
122
+ "./xod": {
123
+ "types": "./dist/xod.d.ts",
124
+ "default": "./dist/xod.js"
125
+ },
126
+ "./zipper": {
127
+ "types": "./dist/zipper.d.ts",
128
+ "default": "./dist/zipper.js"
129
+ }
130
+ },
131
+ "peerDependencies": {
132
+ "zod": "^4.0.0"
133
+ },
134
+ "peerDependenciesMeta": {
135
+ "zod": {
136
+ "optional": true
137
+ }
138
+ },
139
+ "dependencies": {
140
+ "@std/msgpack": "jsr:^1.0.0"
141
+ },
142
+ "devDependencies": {
143
+ "@nemigo/configs": "workspace:*",
144
+ "zod": "4.1.5"
145
+ }
146
+ }