@pawover/kit 0.0.0-beta.41 → 0.0.0-beta.42
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.
- package/dist/enums.d.ts +1 -1
- package/dist/{except-MacUK44u.d.ts → except-C_xUtgFe.d.ts} +44 -19
- package/dist/except-C_xUtgFe.d.ts.map +1 -0
- package/dist/hooks-react.d.ts +42 -10
- package/dist/hooks-react.d.ts.map +1 -1
- package/dist/hooks-react.js +48 -39
- package/dist/hooks-react.js.map +1 -1
- package/dist/{index-Bn_PNnsM.d.ts → index-CN5K25yO.d.ts} +2 -2
- package/dist/{index-Bn_PNnsM.d.ts.map → index-CN5K25yO.d.ts.map} +1 -1
- package/dist/index-DBPmnr4a.d.ts.map +1 -1
- package/dist/index.d.ts +345 -34
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/patches-fetchEventSource.d.ts +1 -1
- package/dist/patches-fetchEventSource.js +1 -1
- package/dist/{utils-_dtCs-qa.js → utils-adQi5T1g.js} +12 -2
- package/dist/utils-adQi5T1g.js.map +1 -0
- package/dist/{value-of-DUmTbnuw.d.ts → value-of-DPr10cdW.d.ts} +2 -2
- package/dist/{value-of-DUmTbnuw.d.ts.map → value-of-DPr10cdW.d.ts.map} +1 -1
- package/package.json +11 -7
- package/dist/except-MacUK44u.d.ts.map +0 -1
- package/dist/utils-_dtCs-qa.js.map +0 -1
package/dist/enums.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { a as MIME, c as DATE_FORMAT, i as THEME_TYPE, n as THEME_MODE_ENUM, o as BREAK_POINT_TOKEN_ENUM, r as THEME_MODE_TYPE, s as BREAK_POINT_TOKEN_TYPE, t as THEME_ENUM } from "./index-
|
|
1
|
+
import { a as MIME, c as DATE_FORMAT, i as THEME_TYPE, n as THEME_MODE_ENUM, o as BREAK_POINT_TOKEN_ENUM, r as THEME_MODE_TYPE, s as BREAK_POINT_TOKEN_TYPE, t as THEME_ENUM } from "./index-CN5K25yO.js";
|
|
2
2
|
export { BREAK_POINT_TOKEN_ENUM, BREAK_POINT_TOKEN_TYPE, DATE_FORMAT, MIME, THEME_ENUM, THEME_MODE_ENUM, THEME_MODE_TYPE, THEME_TYPE };
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
//#region node_modules/.pnpm/type-fest@5.
|
|
1
|
+
//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/union-to-intersection.d.ts
|
|
2
2
|
/**
|
|
3
3
|
Convert a union type to an intersection type using [distributive conditional types](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html#distributive-conditional-types).
|
|
4
4
|
|
|
@@ -32,7 +32,7 @@ Union extends unknown
|
|
|
32
32
|
// The `& Union` is to ensure result of `UnionToIntersection<A | B>` is always assignable to `A | B`
|
|
33
33
|
? Intersection & Union : never;
|
|
34
34
|
//#endregion
|
|
35
|
-
//#region node_modules/.pnpm/type-fest@5.
|
|
35
|
+
//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/keys-of-union.d.ts
|
|
36
36
|
/**
|
|
37
37
|
Create a union of all keys from a given type, even those exclusive to specific union members.
|
|
38
38
|
|
|
@@ -74,7 +74,7 @@ type KeysOfUnion<ObjectType> =
|
|
|
74
74
|
// Hack to fix https://github.com/sindresorhus/type-fest/issues/1008
|
|
75
75
|
keyof UnionToIntersection<ObjectType extends unknown ? Record<keyof ObjectType, never> : never>;
|
|
76
76
|
//#endregion
|
|
77
|
-
//#region node_modules/.pnpm/type-fest@5.
|
|
77
|
+
//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/is-any.d.ts
|
|
78
78
|
/**
|
|
79
79
|
Returns a boolean for whether the given type is `any`.
|
|
80
80
|
|
|
@@ -105,7 +105,7 @@ const anyA = get(anyObject, 'a');
|
|
|
105
105
|
*/
|
|
106
106
|
type IsAny<T> = 0 extends 1 & NoInfer<T> ? true : false;
|
|
107
107
|
//#endregion
|
|
108
|
-
//#region node_modules/.pnpm/type-fest@5.
|
|
108
|
+
//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/is-optional-key-of.d.ts
|
|
109
109
|
/**
|
|
110
110
|
Returns a boolean for whether the given key is an optional key of type.
|
|
111
111
|
|
|
@@ -148,7 +148,7 @@ type T5 = IsOptionalKeyOf<User | Admin, 'surname'>;
|
|
|
148
148
|
*/
|
|
149
149
|
type IsOptionalKeyOf<Type extends object, Key$1 extends keyof Type> = IsAny<Type | Key$1> extends true ? never : Key$1 extends keyof Type ? Type extends Record<Key$1, Type[Key$1]> ? false : true : false;
|
|
150
150
|
//#endregion
|
|
151
|
-
//#region node_modules/.pnpm/type-fest@5.
|
|
151
|
+
//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/optional-keys-of.d.ts
|
|
152
152
|
/**
|
|
153
153
|
Extract all optional keys from the given type.
|
|
154
154
|
|
|
@@ -186,7 +186,7 @@ type OptionalKeysOf<Type extends object> = Type extends unknown // For distribut
|
|
|
186
186
|
? (keyof { [Key in keyof Type as IsOptionalKeyOf<Type, Key> extends false ? never : Key]: never }) & keyof Type // Intersect with `keyof Type` to ensure result of `OptionalKeysOf<Type>` is always assignable to `keyof Type`
|
|
187
187
|
: never;
|
|
188
188
|
//#endregion
|
|
189
|
-
//#region node_modules/.pnpm/type-fest@5.
|
|
189
|
+
//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/required-keys-of.d.ts
|
|
190
190
|
/**
|
|
191
191
|
Extract all required keys from the given type.
|
|
192
192
|
|
|
@@ -220,7 +220,7 @@ const validator3 = createValidation<User>('luckyNumber', value => value > 0);
|
|
|
220
220
|
type RequiredKeysOf<Type extends object> = Type extends unknown // For distributing `Type`
|
|
221
221
|
? Exclude<keyof Type, OptionalKeysOf<Type>> : never;
|
|
222
222
|
//#endregion
|
|
223
|
-
//#region node_modules/.pnpm/type-fest@5.
|
|
223
|
+
//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/is-never.d.ts
|
|
224
224
|
/**
|
|
225
225
|
Returns a boolean for whether the given type is `never`.
|
|
226
226
|
|
|
@@ -276,7 +276,7 @@ type B = IsTrueFixed<never>;
|
|
|
276
276
|
*/
|
|
277
277
|
type IsNever<T> = [T] extends [never] ? true : false;
|
|
278
278
|
//#endregion
|
|
279
|
-
//#region node_modules/.pnpm/type-fest@5.
|
|
279
|
+
//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/if.d.ts
|
|
280
280
|
/**
|
|
281
281
|
An if-else-like type that resolves depending on whether the given `boolean` type is `true` or `false`.
|
|
282
282
|
|
|
@@ -371,7 +371,7 @@ type Works = IncludesWithoutIf<HundredZeroes, '1'>;
|
|
|
371
371
|
*/
|
|
372
372
|
type If<Type extends boolean, IfBranch, ElseBranch> = IsNever<Type> extends true ? ElseBranch : Type extends true ? IfBranch : ElseBranch;
|
|
373
373
|
//#endregion
|
|
374
|
-
//#region node_modules/.pnpm/type-fest@5.
|
|
374
|
+
//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/unknown-array.d.ts
|
|
375
375
|
/**
|
|
376
376
|
Represents an array with `unknown` value.
|
|
377
377
|
|
|
@@ -398,7 +398,7 @@ type C = IsArray<string>;
|
|
|
398
398
|
*/
|
|
399
399
|
type UnknownArray = readonly unknown[];
|
|
400
400
|
//#endregion
|
|
401
|
-
//#region node_modules/.pnpm/type-fest@5.
|
|
401
|
+
//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/internal/type.d.ts
|
|
402
402
|
/**
|
|
403
403
|
Returns a boolean for whether A is false.
|
|
404
404
|
|
|
@@ -462,7 +462,7 @@ Indicates the value of `exactOptionalPropertyTypes` compiler option.
|
|
|
462
462
|
*/
|
|
463
463
|
type IsExactOptionalPropertyTypesEnabled = [(string | undefined)?] extends [string?] ? false : true;
|
|
464
464
|
//#endregion
|
|
465
|
-
//#region node_modules/.pnpm/type-fest@5.
|
|
465
|
+
//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/simplify.d.ts
|
|
466
466
|
/**
|
|
467
467
|
Useful to flatten the type output to improve type hints shown in editors. And also to transform an interface into a type to aide with assignability.
|
|
468
468
|
|
|
@@ -523,7 +523,7 @@ fn(someInterface as Simplify<SomeInterface>); // Good: transform an `interface`
|
|
|
523
523
|
*/
|
|
524
524
|
type Simplify<T> = { [KeyType in keyof T]: T[KeyType] } & {};
|
|
525
525
|
//#endregion
|
|
526
|
-
//#region node_modules/.pnpm/type-fest@5.
|
|
526
|
+
//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/is-equal.d.ts
|
|
527
527
|
/**
|
|
528
528
|
Returns a boolean for whether the two given types are equal.
|
|
529
529
|
|
|
@@ -554,7 +554,7 @@ type IsEqual<A, B> = [A] extends [B] ? [B] extends [A] ? _IsEqual<A, B> : false
|
|
|
554
554
|
// This version fails the `equalWrappedTupleIntersectionToBeNeverAndNeverExpanded` test in `test-d/is-equal.ts`.
|
|
555
555
|
type _IsEqual<A, B> = (<G>() => G extends A & G | G ? 1 : 2) extends (<G>() => G extends B & G | G ? 1 : 2) ? true : false;
|
|
556
556
|
//#endregion
|
|
557
|
-
//#region node_modules/.pnpm/type-fest@5.
|
|
557
|
+
//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/omit-index-signature.d.ts
|
|
558
558
|
/**
|
|
559
559
|
Omit any index signatures from the given object type, leaving only explicitly defined properties.
|
|
560
560
|
|
|
@@ -648,7 +648,7 @@ type ExampleWithoutIndexSignatures = OmitIndexSignature<Example>;
|
|
|
648
648
|
*/
|
|
649
649
|
type OmitIndexSignature<ObjectType> = { [KeyType in keyof ObjectType as {} extends Record<KeyType, unknown> ? never : KeyType]: ObjectType[KeyType] };
|
|
650
650
|
//#endregion
|
|
651
|
-
//#region node_modules/.pnpm/type-fest@5.
|
|
651
|
+
//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/pick-index-signature.d.ts
|
|
652
652
|
/**
|
|
653
653
|
Pick only index signatures from the given object type, leaving out all explicitly defined properties.
|
|
654
654
|
|
|
@@ -696,13 +696,38 @@ type ExampleIndexSignature = PickIndexSignature<Example>;
|
|
|
696
696
|
*/
|
|
697
697
|
type PickIndexSignature<ObjectType> = { [KeyType in keyof ObjectType as {} extends Record<KeyType, unknown> ? KeyType : never]: ObjectType[KeyType] };
|
|
698
698
|
//#endregion
|
|
699
|
-
//#region node_modules/.pnpm/type-fest@5.
|
|
699
|
+
//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/merge.d.ts
|
|
700
700
|
// Merges two objects without worrying about index signatures.
|
|
701
701
|
type SimpleMerge<Destination, Source> = Simplify<{ [Key in keyof Destination as Key extends keyof Source ? never : Key]: Destination[Key] } & Source>;
|
|
702
702
|
|
|
703
703
|
/**
|
|
704
704
|
Merge two types into a new type. Keys of the second type overrides keys of the first type.
|
|
705
705
|
|
|
706
|
+
This is different from the TypeScript `&` (intersection) operator. With `&`, conflicting property types are intersected, which often results in `never`. For example, `{a: string} & {a: number}` makes `a` become `string & number`, which resolves to `never`. With `Merge`, the second type's keys cleanly override the first, so `Merge<{a: string}, {a: number}>` gives `{a: number}` as expected. `Merge` also produces a flattened type (via `Simplify`), making it more readable in IDE tooltips compared to `A & B`.
|
|
707
|
+
|
|
708
|
+
@example
|
|
709
|
+
```
|
|
710
|
+
import type {Merge} from 'type-fest';
|
|
711
|
+
|
|
712
|
+
type Foo = {
|
|
713
|
+
a: string;
|
|
714
|
+
b: number;
|
|
715
|
+
};
|
|
716
|
+
|
|
717
|
+
type Bar = {
|
|
718
|
+
a: number; // Conflicts with Foo['a']
|
|
719
|
+
c: boolean;
|
|
720
|
+
};
|
|
721
|
+
|
|
722
|
+
// With `&`, `a` becomes `string & number` which is `never`. Not what you want.
|
|
723
|
+
type WithIntersection = (Foo & Bar)['a'];
|
|
724
|
+
//=> never
|
|
725
|
+
|
|
726
|
+
// With `Merge`, `a` is cleanly overridden to `number`.
|
|
727
|
+
type WithMerge = Merge<Foo, Bar>['a'];
|
|
728
|
+
//=> number
|
|
729
|
+
```
|
|
730
|
+
|
|
706
731
|
@example
|
|
707
732
|
```
|
|
708
733
|
import type {Merge} from 'type-fest';
|
|
@@ -745,7 +770,7 @@ type Merge<Destination, Source> = Destination extends unknown // For distributin
|
|
|
745
770
|
|
|
746
771
|
type _Merge<Destination, Source> = Simplify<SimpleMerge<PickIndexSignature<Destination>, PickIndexSignature<Source>> & SimpleMerge<OmitIndexSignature<Destination>, OmitIndexSignature<Source>>>;
|
|
747
772
|
//#endregion
|
|
748
|
-
//#region node_modules/.pnpm/type-fest@5.
|
|
773
|
+
//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/internal/object.d.ts
|
|
749
774
|
/**
|
|
750
775
|
Works similar to the built-in `Pick` utility type, except for the following differences:
|
|
751
776
|
- Distributes over union types and allows picking keys from any member of the union type.
|
|
@@ -868,7 +893,7 @@ type E = CollapseLiterals<LiteralUnion<'foo' | 'bar', string> | null | undefined
|
|
|
868
893
|
*/
|
|
869
894
|
type CollapseLiterals<T> = {} extends T ? T : T extends infer U & {} ? U : T;
|
|
870
895
|
//#endregion
|
|
871
|
-
//#region node_modules/.pnpm/type-fest@5.
|
|
896
|
+
//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/except.d.ts
|
|
872
897
|
/**
|
|
873
898
|
Filter out keys from an object.
|
|
874
899
|
|
|
@@ -967,5 +992,5 @@ type PostPayloadFixed = Except<UserData, 'email'>;
|
|
|
967
992
|
type Except<ObjectType, KeysType extends keyof ObjectType, Options extends ExceptOptions = {}> = _Except<ObjectType, KeysType, ApplyDefaultOptions<ExceptOptions, DefaultExceptOptions, Options>>;
|
|
968
993
|
type _Except<ObjectType, KeysType extends keyof ObjectType, Options extends Required<ExceptOptions>> = { [KeyType in keyof ObjectType as Filter<KeyType, KeysType>]: ObjectType[KeyType] } & (Options['requireExactProps'] extends true ? Partial<Record<KeysType, never>> : {});
|
|
969
994
|
//#endregion
|
|
970
|
-
export {
|
|
971
|
-
//# sourceMappingURL=except-
|
|
995
|
+
export { IsEqual as a, IsExactOptionalPropertyTypesEnabled as c, If as d, IsNever as f, UnionToIntersection as h, HomomorphicPick as i, Not as l, IsAny as m, ApplyDefaultOptions as n, Simplify as o, OptionalKeysOf as p, CollapseLiterals as r, IfNotAnyOrNever as s, Except as t, UnknownArray as u };
|
|
996
|
+
//# sourceMappingURL=except-C_xUtgFe.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"except-C_xUtgFe.d.ts","names":["UnionToIntersection","Union","Intersection","UnionToIntersection","KeysOfUnion","ObjectType","Record","IsAny","T","NoInfer","IsAny","IsOptionalKeyOf","Type","Key","Record","IsOptionalKeyOf","OptionalKeysOf","Type","Key","OptionalKeysOf","RequiredKeysOf","Type","Exclude","IsNever","T","IsNever","If","Type","IfBranch","ElseBranch","UnknownArray","If","IsAny","IsNever","Primitive","UnknownArray","UnionToIntersection","BuiltIns","Date","RegExp","NonRecursiveType","Function","Promise","MapsSetsOrArrays","ReadonlyMap","WeakKey","WeakMap","ReadonlySet","WeakSet","IsBothExtends","BaseType","FirstType","SecondType","HasMultipleCallSignatures","T","IsNotFalse","IsPrimitive","Not","A","IfNotAnyOrNever","IfAny","IfNever","IsAnyOrNever","IsExactOptionalPropertyTypesEnabled","Simplify","T","KeyType","IsEqual","A","B","_IsEqual","G","OmitIndexSignature","ObjectType","KeyType","Record","PickIndexSignature","ObjectType","KeyType","Record","OmitIndexSignature","PickIndexSignature","Simplify","If","IsEqual","SimpleMerge","Destination","Source","Key","Merge","_Merge","Simplify","IsEqual","KeysOfUnion","RequiredKeysOf","Merge","OptionalKeysOf","IsAny","If","IsNever","FilterDefinedKeys","FilterOptionalKeys","MapsSetsOrArrays","NonRecursiveType","StringToNumber","ToString","BuildObject","Key","Value","CopiedFrom","PropertyKey","Pick","NumberKey","IsPlainObject","T","ObjectValue","K","NumberK","UndefinedToOptional","Exclude","HomomorphicPick","Keys","P","Extract","ValueOfUnion","Union","ReadonlyKeysOfUnion","ApplyDefaultOptions","Options","Defaults","SpecifiedOptions","Required","Omit","Record","Partial","CollapseLiterals","NormalizedKeys","ApplyDefaultOptions","IsEqual","Filter","KeyType","ExcludeType","ExceptOptions","DefaultExceptOptions","Except","ObjectType","KeysType","Options","_Except","Required","Record","Partial"],"sources":["../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/union-to-intersection.d.ts","../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/keys-of-union.d.ts","../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/is-any.d.ts","../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/is-optional-key-of.d.ts","../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/optional-keys-of.d.ts","../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/required-keys-of.d.ts","../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/is-never.d.ts","../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/if.d.ts","../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/unknown-array.d.ts","../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/internal/type.d.ts","../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/simplify.d.ts","../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/is-equal.d.ts","../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/omit-index-signature.d.ts","../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/pick-index-signature.d.ts","../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/merge.d.ts","../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/internal/object.d.ts","../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/except.d.ts"],"sourcesContent":["/**\nConvert a union type to an intersection type using [distributive conditional types](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html#distributive-conditional-types).\n\nInspired by [this Stack Overflow answer](https://stackoverflow.com/a/50375286/2172153).\n\n@example\n```\nimport type {UnionToIntersection} from 'type-fest';\n\ntype Union = {the(): void} | {great(arg: string): void} | {escape: boolean};\n\ntype Intersection = UnionToIntersection<Union>;\n//=> {the(): void} & {great(arg: string): void} & {escape: boolean}\n```\n\n@category Type\n*/\nexport type UnionToIntersection<Union> = (\n\t// `extends unknown` is always going to be the case and is used to convert the\n\t// `Union` into a [distributive conditional\n\t// type](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html#distributive-conditional-types).\n\tUnion extends unknown\n\t\t// The union type is used as the only argument to a function since the union\n\t\t// of function arguments is an intersection.\n\t\t? (distributedUnion: Union) => void\n\t\t// This won't happen.\n\t\t: never\n\t\t// Infer the `Intersection` type since TypeScript represents the positional\n\t\t// arguments of unions of functions as an intersection of the union.\n) extends ((mergedIntersection: infer Intersection) => void)\n\t// The `& Union` is to ensure result of `UnionToIntersection<A | B>` is always assignable to `A | B`\n\t? Intersection & Union\n\t: never;\n\nexport {};\n","import type {UnionToIntersection} from './union-to-intersection.d.ts';\n\n/**\nCreate a union of all keys from a given type, even those exclusive to specific union members.\n\nUnlike the native `keyof` keyword, which returns keys present in **all** union members, this type returns keys from **any** member.\n\n@link https://stackoverflow.com/a/49402091\n\n@example\n```\nimport type {KeysOfUnion} from 'type-fest';\n\ntype A = {\n\tcommon: string;\n\ta: number;\n};\n\ntype B = {\n\tcommon: string;\n\tb: string;\n};\n\ntype C = {\n\tcommon: string;\n\tc: boolean;\n};\n\ntype Union = A | B | C;\n\ntype CommonKeys = keyof Union;\n//=> 'common'\n\ntype AllKeys = KeysOfUnion<Union>;\n//=> 'common' | 'a' | 'b' | 'c'\n```\n\n@category Object\n*/\nexport type KeysOfUnion<ObjectType> =\n // Hack to fix https://github.com/sindresorhus/type-fest/issues/1008\n keyof UnionToIntersection<ObjectType extends unknown ? Record<keyof ObjectType, never> : never>;\n\nexport {};\n","/**\nReturns a boolean for whether the given type is `any`.\n\n@link https://stackoverflow.com/a/49928360/1490091\n\nUseful in type utilities, such as disallowing `any`s to be passed to a function.\n\n@example\n```\nimport type {IsAny} from 'type-fest';\n\nconst typedObject = {a: 1, b: 2} as const;\nconst anyObject: any = {a: 1, b: 2};\n\nfunction get<O extends (IsAny<O> extends true ? {} : Record<string, number>), K extends keyof O = keyof O>(object: O, key: K) {\n\treturn object[key];\n}\n\nconst typedA = get(typedObject, 'a');\n//=> 1\n\nconst anyA = get(anyObject, 'a');\n//=> any\n```\n\n@category Type Guard\n@category Utilities\n*/\nexport type IsAny<T> = 0 extends 1 & NoInfer<T> ? true : false;\n\nexport {};\n","import type {IsAny} from './is-any.d.ts';\n\n/**\nReturns a boolean for whether the given key is an optional key of type.\n\nThis is useful when writing utility types or schema validators that need to differentiate `optional` keys.\n\n@example\n```\nimport type {IsOptionalKeyOf} from 'type-fest';\n\ntype User = {\n\tname: string;\n\tsurname: string;\n\n\tluckyNumber?: number;\n};\n\ntype Admin = {\n\tname: string;\n\tsurname?: string;\n};\n\ntype T1 = IsOptionalKeyOf<User, 'luckyNumber'>;\n//=> true\n\ntype T2 = IsOptionalKeyOf<User, 'name'>;\n//=> false\n\ntype T3 = IsOptionalKeyOf<User, 'name' | 'luckyNumber'>;\n//=> boolean\n\ntype T4 = IsOptionalKeyOf<User | Admin, 'name'>;\n//=> false\n\ntype T5 = IsOptionalKeyOf<User | Admin, 'surname'>;\n//=> boolean\n```\n\n@category Type Guard\n@category Utilities\n*/\nexport type IsOptionalKeyOf<Type extends object, Key extends keyof Type> =\n\tIsAny<Type | Key> extends true ? never\n\t\t: Key extends keyof Type\n\t\t\t? Type extends Record<Key, Type[Key]>\n\t\t\t\t? false\n\t\t\t\t: true\n\t\t\t: false;\n\nexport {};\n","import type {IsOptionalKeyOf} from './is-optional-key-of.d.ts';\n\n/**\nExtract all optional keys from the given type.\n\nThis is useful when you want to create a new type that contains different type values for the optional keys only.\n\n@example\n```\nimport type {OptionalKeysOf, Except} from 'type-fest';\n\ntype User = {\n\tname: string;\n\tsurname: string;\n\n\tluckyNumber?: number;\n};\n\nconst REMOVE_FIELD = Symbol('remove field symbol');\ntype UpdateOperation<Entity extends object> = Except<Partial<Entity>, OptionalKeysOf<Entity>> & {\n\t[Key in OptionalKeysOf<Entity>]?: Entity[Key] | typeof REMOVE_FIELD;\n};\n\nconst update1: UpdateOperation<User> = {\n\tname: 'Alice',\n};\n\nconst update2: UpdateOperation<User> = {\n\tname: 'Bob',\n\tluckyNumber: REMOVE_FIELD,\n};\n```\n\n@category Utilities\n*/\nexport type OptionalKeysOf<Type extends object> =\n\tType extends unknown // For distributing `Type`\n\t\t? (keyof {[Key in keyof Type as\n\t\t\tIsOptionalKeyOf<Type, Key> extends false\n\t\t\t\t? never\n\t\t\t\t: Key\n\t\t\t]: never\n\t\t}) & keyof Type // Intersect with `keyof Type` to ensure result of `OptionalKeysOf<Type>` is always assignable to `keyof Type`\n\t\t: never; // Should never happen\n\nexport {};\n","import type {OptionalKeysOf} from './optional-keys-of.d.ts';\n\n/**\nExtract all required keys from the given type.\n\nThis is useful when you want to create a new type that contains different type values for the required keys only or use the list of keys for validation purposes, etc...\n\n@example\n```\nimport type {RequiredKeysOf} from 'type-fest';\n\ndeclare function createValidation<\n\tEntity extends object,\n\tKey extends RequiredKeysOf<Entity> = RequiredKeysOf<Entity>,\n>(field: Key, validator: (value: Entity[Key]) => boolean): (entity: Entity) => boolean;\n\ntype User = {\n\tname: string;\n\tsurname: string;\n\tluckyNumber?: number;\n};\n\nconst validator1 = createValidation<User>('name', value => value.length < 25);\nconst validator2 = createValidation<User>('surname', value => value.length < 25);\n\n// @ts-expect-error\nconst validator3 = createValidation<User>('luckyNumber', value => value > 0);\n// Error: Argument of type '\"luckyNumber\"' is not assignable to parameter of type '\"name\" | \"surname\"'.\n```\n\n@category Utilities\n*/\nexport type RequiredKeysOf<Type extends object> =\n\tType extends unknown // For distributing `Type`\n\t\t? Exclude<keyof Type, OptionalKeysOf<Type>>\n\t\t: never; // Should never happen\n\nexport {};\n","/**\nReturns a boolean for whether the given type is `never`.\n\n@link https://github.com/microsoft/TypeScript/issues/31751#issuecomment-498526919\n@link https://stackoverflow.com/a/53984913/10292952\n@link https://www.zhenghao.io/posts/ts-never\n\nUseful in type utilities, such as checking if something does not occur.\n\n@example\n```\nimport type {IsNever, And} from 'type-fest';\n\ntype A = IsNever<never>;\n//=> true\n\ntype B = IsNever<any>;\n//=> false\n\ntype C = IsNever<unknown>;\n//=> false\n\ntype D = IsNever<never[]>;\n//=> false\n\ntype E = IsNever<object>;\n//=> false\n\ntype F = IsNever<string>;\n//=> false\n```\n\n@example\n```\nimport type {IsNever} from 'type-fest';\n\ntype IsTrue<T> = T extends true ? true : false;\n\n// When a distributive conditional is instantiated with `never`, the entire conditional results in `never`.\ntype A = IsTrue<never>;\n//=> never\n\n// If you don't want that behaviour, you can explicitly add an `IsNever` check before the distributive conditional.\ntype IsTrueFixed<T> =\n\tIsNever<T> extends true ? false : T extends true ? true : false;\n\ntype B = IsTrueFixed<never>;\n//=> false\n```\n\n@category Type Guard\n@category Utilities\n*/\nexport type IsNever<T> = [T] extends [never] ? true : false;\n\nexport {};\n","import type {IsNever} from './is-never.d.ts';\n\n/**\nAn if-else-like type that resolves depending on whether the given `boolean` type is `true` or `false`.\n\nUse-cases:\n- You can use this in combination with `Is*` types to create an if-else-like experience. For example, `If<IsAny<any>, 'is any', 'not any'>`.\n\nNote:\n- Returns a union of if branch and else branch if the given type is `boolean` or `any`. For example, `If<boolean, 'Y', 'N'>` will return `'Y' | 'N'`.\n- Returns the else branch if the given type is `never`. For example, `If<never, 'Y', 'N'>` will return `'N'`.\n\n@example\n```\nimport type {If} from 'type-fest';\n\ntype A = If<true, 'yes', 'no'>;\n//=> 'yes'\n\ntype B = If<false, 'yes', 'no'>;\n//=> 'no'\n\ntype C = If<boolean, 'yes', 'no'>;\n//=> 'yes' | 'no'\n\ntype D = If<any, 'yes', 'no'>;\n//=> 'yes' | 'no'\n\ntype E = If<never, 'yes', 'no'>;\n//=> 'no'\n```\n\n@example\n```\nimport type {If, IsAny, IsNever} from 'type-fest';\n\ntype A = If<IsAny<unknown>, 'is any', 'not any'>;\n//=> 'not any'\n\ntype B = If<IsNever<never>, 'is never', 'not never'>;\n//=> 'is never'\n```\n\n@example\n```\nimport type {If, IsEqual} from 'type-fest';\n\ntype IfEqual<T, U, IfBranch, ElseBranch> = If<IsEqual<T, U>, IfBranch, ElseBranch>;\n\ntype A = IfEqual<string, string, 'equal', 'not equal'>;\n//=> 'equal'\n\ntype B = IfEqual<string, number, 'equal', 'not equal'>;\n//=> 'not equal'\n```\n\nNote: Sometimes using the `If` type can make an implementation non–tail-recursive, which can impact performance. In such cases, it’s better to use a conditional directly. Refer to the following example:\n\n@example\n```\nimport type {If, IsEqual, StringRepeat} from 'type-fest';\n\ntype HundredZeroes = StringRepeat<'0', 100>;\n\n// The following implementation is not tail recursive\ntype Includes<S extends string, Char extends string> =\n\tS extends `${infer First}${infer Rest}`\n\t\t? If<IsEqual<First, Char>,\n\t\t\t'found',\n\t\t\tIncludes<Rest, Char>>\n\t\t: 'not found';\n\n// Hence, instantiations with long strings will fail\n// @ts-expect-error\ntype Fails = Includes<HundredZeroes, '1'>;\n// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n// Error: Type instantiation is excessively deep and possibly infinite.\n\n// However, if we use a simple conditional instead of `If`, the implementation becomes tail-recursive\ntype IncludesWithoutIf<S extends string, Char extends string> =\n\tS extends `${infer First}${infer Rest}`\n\t\t? IsEqual<First, Char> extends true\n\t\t\t? 'found'\n\t\t\t: IncludesWithoutIf<Rest, Char>\n\t\t: 'not found';\n\n// Now, instantiations with long strings will work\ntype Works = IncludesWithoutIf<HundredZeroes, '1'>;\n//=> 'not found'\n```\n\n@category Type Guard\n@category Utilities\n*/\nexport type If<Type extends boolean, IfBranch, ElseBranch> =\n\tIsNever<Type> extends true\n\t\t? ElseBranch\n\t\t: Type extends true\n\t\t\t? IfBranch\n\t\t\t: ElseBranch;\n\nexport {};\n","/**\nRepresents an array with `unknown` value.\n\nUse case: You want a type that all arrays can be assigned to, but you don't care about the value.\n\n@example\n```\nimport type {UnknownArray} from 'type-fest';\n\ntype IsArray<T> = T extends UnknownArray ? true : false;\n\ntype A = IsArray<['foo']>;\n//=> true\n\ntype B = IsArray<readonly number[]>;\n//=> true\n\ntype C = IsArray<string>;\n//=> false\n```\n\n@category Type\n@category Array\n*/\nexport type UnknownArray = readonly unknown[];\n\nexport {};\n","import type {If} from '../if.d.ts';\nimport type {IsAny} from '../is-any.d.ts';\nimport type {IsNever} from '../is-never.d.ts';\nimport type {Primitive} from '../primitive.d.ts';\nimport type {UnknownArray} from '../unknown-array.d.ts';\nimport type {UnionToIntersection} from '../union-to-intersection.d.ts';\n\n/**\nMatches any primitive, `void`, `Date`, or `RegExp` value.\n*/\nexport type BuiltIns = Primitive | void | Date | RegExp;\n\n/**\nMatches non-recursive types.\n*/\nexport type NonRecursiveType = BuiltIns | Function | (new (...arguments_: any[]) => unknown) | Promise<unknown>;\n\n/**\nMatches maps, sets, or arrays.\n*/\nexport type MapsSetsOrArrays = ReadonlyMap<unknown, unknown> | WeakMap<WeakKey, unknown> | ReadonlySet<unknown> | WeakSet<WeakKey> | UnknownArray;\n\n/**\nReturns a boolean for whether the two given types extends the base type.\n*/\nexport type IsBothExtends<BaseType, FirstType, SecondType> = FirstType extends BaseType\n\t? SecondType extends BaseType\n\t\t? true\n\t\t: false\n\t: false;\n\n/**\nTest if the given function has multiple call signatures.\n\nNeeded to handle the case of a single call signature with properties.\n\nMultiple call signatures cannot currently be supported due to a TypeScript limitation.\n@see https://github.com/microsoft/TypeScript/issues/29732\n*/\nexport type HasMultipleCallSignatures<T extends (...arguments_: any[]) => unknown> =\n\tT extends {(...arguments_: infer A): unknown; (...arguments_: infer B): unknown}\n\t\t? B extends A\n\t\t\t? A extends B\n\t\t\t\t? false\n\t\t\t\t: true\n\t\t\t: true\n\t\t: false;\n\n/**\nReturns a boolean for whether the given `boolean` is not `false`.\n*/\nexport type IsNotFalse<T extends boolean> = [T] extends [false] ? false : true;\n\n/**\nReturns a boolean for whether the given type is primitive value or primitive type.\n\n@example\n```\ntype A = IsPrimitive<'string'>;\n//=> true\n\ntype B = IsPrimitive<string>;\n//=> true\n\ntype C = IsPrimitive<Object>;\n//=> false\n```\n*/\nexport type IsPrimitive<T> = [T] extends [Primitive] ? true : false;\n\n/**\nReturns a boolean for whether A is false.\n\n@example\n```\ntype A = Not<true>;\n//=> false\n\ntype B = Not<false>;\n//=> true\n```\n*/\nexport type Not<A extends boolean> = A extends true\n\t? false\n\t: A extends false\n\t\t? true\n\t\t: never;\n\n/**\nAn if-else-like type that resolves depending on whether the given type is `any` or `never`.\n\n@example\n```\n// When `T` is a NOT `any` or `never` (like `string`) => Returns `IfNotAnyOrNever` branch\ntype A = IfNotAnyOrNever<string, 'VALID', 'IS_ANY', 'IS_NEVER'>;\n//=> 'VALID'\n\n// When `T` is `any` => Returns `IfAny` branch\ntype B = IfNotAnyOrNever<any, 'VALID', 'IS_ANY', 'IS_NEVER'>;\n//=> 'IS_ANY'\n\n// When `T` is `never` => Returns `IfNever` branch\ntype C = IfNotAnyOrNever<never, 'VALID', 'IS_ANY', 'IS_NEVER'>;\n//=> 'IS_NEVER'\n```\n\nNote: Wrapping a tail-recursive type with `IfNotAnyOrNever` makes the implementation non-tail-recursive. To fix this, move the recursion into a helper type. Refer to the following example:\n\n@example\n```ts\nimport type {StringRepeat} from 'type-fest';\n\ntype NineHundredNinetyNineSpaces = StringRepeat<' ', 999>;\n\n// The following implementation is not tail recursive\ntype TrimLeft<S extends string> = IfNotAnyOrNever<S, S extends ` ${infer R}` ? TrimLeft<R> : S>;\n\n// Hence, instantiations with long strings will fail\n// @ts-expect-error\ntype T1 = TrimLeft<NineHundredNinetyNineSpaces>;\n// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n// Error: Type instantiation is excessively deep and possibly infinite.\n\n// To fix this, move the recursion into a helper type\ntype TrimLeftOptimised<S extends string> = IfNotAnyOrNever<S, _TrimLeftOptimised<S>>;\n\ntype _TrimLeftOptimised<S extends string> = S extends ` ${infer R}` ? _TrimLeftOptimised<R> : S;\n\ntype T2 = TrimLeftOptimised<NineHundredNinetyNineSpaces>;\n//=> ''\n```\n*/\nexport type IfNotAnyOrNever<T, IfNotAnyOrNever, IfAny = any, IfNever = never> =\n\tIf<IsAny<T>, IfAny, If<IsNever<T>, IfNever, IfNotAnyOrNever>>;\n\n/**\nReturns a boolean for whether the given type is `any` or `never`.\n\nThis type can be better to use than {@link IfNotAnyOrNever `IfNotAnyOrNever`} in recursive types because it does not evaluate any branches.\n\n@example\n```\n// When `T` is a NOT `any` or `never` (like `string`) => Returns `false`\ntype A = IsAnyOrNever<string>;\n//=> false\n\n// When `T` is `any` => Returns `true`\ntype B = IsAnyOrNever<any>;\n//=> true\n\n// When `T` is `never` => Returns `true`\ntype C = IsAnyOrNever<never>;\n//=> true\n```\n*/\nexport type IsAnyOrNever<T> = IsNotFalse<IsAny<T> | IsNever<T>>;\n\n/**\nIndicates the value of `exactOptionalPropertyTypes` compiler option.\n*/\nexport type IsExactOptionalPropertyTypesEnabled = [(string | undefined)?] extends [string?]\n\t? false\n\t: true;\n\nexport {};\n","/**\nUseful to flatten the type output to improve type hints shown in editors. And also to transform an interface into a type to aide with assignability.\n\n@example\n```\nimport type {Simplify} from 'type-fest';\n\ntype PositionProps = {\n\ttop: number;\n\tleft: number;\n};\n\ntype SizeProps = {\n\twidth: number;\n\theight: number;\n};\n\n// In your editor, hovering over `Props` will show a flattened object with all the properties.\ntype Props = Simplify<PositionProps & SizeProps>;\n```\n\nSometimes it is desired to pass a value as a function argument that has a different type. At first inspection it may seem assignable, and then you discover it is not because the `value`'s type definition was defined as an interface. In the following example, `fn` requires an argument of type `Record<string, unknown>`. If the value is defined as a literal, then it is assignable. And if the `value` is defined as type using the `Simplify` utility the value is assignable. But if the `value` is defined as an interface, it is not assignable because the interface is not sealed and elsewhere a non-string property could be added to the interface.\n\nIf the type definition must be an interface (perhaps it was defined in a third-party npm package), then the `value` can be defined as `const value: Simplify<SomeInterface> = ...`. Then `value` will be assignable to the `fn` argument. Or the `value` can be cast as `Simplify<SomeInterface>` if you can't re-declare the `value`.\n\n@example\n```\nimport type {Simplify} from 'type-fest';\n\ninterface SomeInterface {\n\tfoo: number;\n\tbar?: string;\n\tbaz: number | undefined;\n}\n\ntype SomeType = {\n\tfoo: number;\n\tbar?: string;\n\tbaz: number | undefined;\n};\n\nconst literal = {foo: 123, bar: 'hello', baz: 456};\nconst someType: SomeType = literal;\nconst someInterface: SomeInterface = literal;\n\ndeclare function fn(object: Record<string, unknown>): void;\n\nfn(literal); // Good: literal object type is sealed\nfn(someType); // Good: type is sealed\n// @ts-expect-error\nfn(someInterface); // Error: Index signature for type 'string' is missing in type 'someInterface'. Because `interface` can be re-opened\nfn(someInterface as Simplify<SomeInterface>); // Good: transform an `interface` into a `type`\n```\n\n@link https://github.com/microsoft/TypeScript/issues/15300\n@see {@link SimplifyDeep}\n@category Object\n*/\nexport type Simplify<T> = {[KeyType in keyof T]: T[KeyType]} & {};\n\nexport {};\n","/**\nReturns a boolean for whether the two given types are equal.\n\n@link https://github.com/microsoft/TypeScript/issues/27024#issuecomment-421529650\n@link https://stackoverflow.com/questions/68961864/how-does-the-equals-work-in-typescript/68963796#68963796\n\nUse-cases:\n- If you want to make a conditional branch based on the result of a comparison of two types.\n\n@example\n```\nimport type {IsEqual} from 'type-fest';\n\n// This type returns a boolean for whether the given array includes the given item.\n// `IsEqual` is used to compare the given array at position 0 and the given item and then return true if they are equal.\ntype Includes<Value extends readonly any[], Item> =\n\tValue extends readonly [Value[0], ...infer rest]\n\t\t? IsEqual<Value[0], Item> extends true\n\t\t\t? true\n\t\t\t: Includes<rest, Item>\n\t\t: false;\n```\n\n@category Type Guard\n@category Utilities\n*/\nexport type IsEqual<A, B> =\n\t[A] extends [B]\n\t\t? [B] extends [A]\n\t\t\t? _IsEqual<A, B>\n\t\t\t: false\n\t\t: false;\n\n// This version fails the `equalWrappedTupleIntersectionToBeNeverAndNeverExpanded` test in `test-d/is-equal.ts`.\ntype _IsEqual<A, B> =\n\t(<G>() => G extends A & G | G ? 1 : 2) extends\n\t(<G>() => G extends B & G | G ? 1 : 2)\n\t\t? true\n\t\t: false;\n\nexport {};\n","/**\nOmit any index signatures from the given object type, leaving only explicitly defined properties.\n\nThis is the counterpart of `PickIndexSignature`.\n\nUse-cases:\n- Remove overly permissive signatures from third-party types.\n\nThis type was taken from this [StackOverflow answer](https://stackoverflow.com/a/68261113/420747).\n\nIt relies on the fact that an empty object (`{}`) is assignable to an object with just an index signature, like `Record<string, unknown>`, but not to an object with explicitly defined keys, like `Record<'foo' | 'bar', unknown>`.\n\n(The actual value type, `unknown`, is irrelevant and could be any type. Only the key type matters.)\n\n```\nconst indexed: Record<string, unknown> = {}; // Allowed\n\n// @ts-expect-error\nconst keyed: Record<'foo', unknown> = {}; // Error\n// TS2739: Type '{}' is missing the following properties from type 'Record<\"foo\" | \"bar\", unknown>': foo, bar\n```\n\nInstead of causing a type error like the above, you can also use a [conditional type](https://www.typescriptlang.org/docs/handbook/2/conditional-types.html) to test whether a type is assignable to another:\n\n```\ntype Indexed = {} extends Record<string, unknown>\n\t? '✅ `{}` is assignable to `Record<string, unknown>`'\n\t: '❌ `{}` is NOT assignable to `Record<string, unknown>`';\n\ntype IndexedResult = Indexed;\n//=> '✅ `{}` is assignable to `Record<string, unknown>`'\n\ntype Keyed = {} extends Record<'foo' | 'bar', unknown>\n\t? '✅ `{}` is assignable to `Record<\\'foo\\' | \\'bar\\', unknown>`'\n\t: '❌ `{}` is NOT assignable to `Record<\\'foo\\' | \\'bar\\', unknown>`';\n\ntype KeyedResult = Keyed;\n//=> '❌ `{}` is NOT assignable to `Record<\\'foo\\' | \\'bar\\', unknown>`'\n```\n\nUsing a [mapped type](https://www.typescriptlang.org/docs/handbook/2/mapped-types.html#further-exploration), you can then check for each `KeyType` of `ObjectType`...\n\n```\ntype OmitIndexSignature<ObjectType> = {\n\t[KeyType in keyof ObjectType // Map each key of `ObjectType`...\n\t]: ObjectType[KeyType]; // ...to its original value, i.e. `OmitIndexSignature<Foo> == Foo`.\n};\n```\n\n...whether an empty object (`{}`) would be assignable to an object with that `KeyType` (`Record<KeyType, unknown>`)...\n\n```\ntype OmitIndexSignature<ObjectType> = {\n\t[KeyType in keyof ObjectType\n\t// Is `{}` assignable to `Record<KeyType, unknown>`?\n\tas {} extends Record<KeyType, unknown>\n\t\t? never // ✅ `{}` is assignable to `Record<KeyType, unknown>`\n\t\t: KeyType // ❌ `{}` is NOT assignable to `Record<KeyType, unknown>`\n\t]: ObjectType[KeyType];\n};\n```\n\nIf `{}` is assignable, it means that `KeyType` is an index signature and we want to remove it. If it is not assignable, `KeyType` is a \"real\" key and we want to keep it.\n\n@example\n```\nimport type {OmitIndexSignature} from 'type-fest';\n\ntype Example = {\n\t// These index signatures will be removed.\n\t[x: string]: any;\n\t[x: number]: any;\n\t[x: symbol]: any;\n\t[x: `head-${string}`]: string;\n\t[x: `${string}-tail`]: string;\n\t[x: `head-${string}-tail`]: string;\n\t[x: `${bigint}`]: string;\n\t[x: `embedded-${number}`]: string;\n\n\t// These explicitly defined keys will remain.\n\tfoo: 'bar';\n\tqux?: 'baz';\n};\n\ntype ExampleWithoutIndexSignatures = OmitIndexSignature<Example>;\n//=> {foo: 'bar'; qux?: 'baz'}\n```\n\n@see {@link PickIndexSignature}\n@category Object\n*/\nexport type OmitIndexSignature<ObjectType> = {\n\t[KeyType in keyof ObjectType as {} extends Record<KeyType, unknown>\n\t\t? never\n\t\t: KeyType]: ObjectType[KeyType];\n};\n\nexport {};\n","/**\nPick only index signatures from the given object type, leaving out all explicitly defined properties.\n\nThis is the counterpart of `OmitIndexSignature`.\n\n@example\n```\nimport type {PickIndexSignature} from 'type-fest';\n\ndeclare const symbolKey: unique symbol;\n\ntype Example = {\n\t// These index signatures will remain.\n\t[x: string]: unknown;\n\t[x: number]: unknown;\n\t[x: symbol]: unknown;\n\t[x: `head-${string}`]: string;\n\t[x: `${string}-tail`]: string;\n\t[x: `head-${string}-tail`]: string;\n\t[x: `${bigint}`]: string;\n\t[x: `embedded-${number}`]: string;\n\n\t// These explicitly defined keys will be removed.\n\t['kebab-case-key']: string;\n\t[symbolKey]: string;\n\tfoo: 'bar';\n\tqux?: 'baz';\n};\n\ntype ExampleIndexSignature = PickIndexSignature<Example>;\n// {\n// \t[x: string]: unknown;\n// \t[x: number]: unknown;\n// \t[x: symbol]: unknown;\n// \t[x: `head-${string}`]: string;\n// \t[x: `${string}-tail`]: string;\n// \t[x: `head-${string}-tail`]: string;\n// \t[x: `${bigint}`]: string;\n// \t[x: `embedded-${number}`]: string;\n// }\n```\n\n@see {@link OmitIndexSignature}\n@category Object\n*/\nexport type PickIndexSignature<ObjectType> = {\n\t[KeyType in keyof ObjectType as {} extends Record<KeyType, unknown>\n\t\t? KeyType\n\t\t: never]: ObjectType[KeyType];\n};\n\nexport {};\n","import type {OmitIndexSignature} from './omit-index-signature.d.ts';\nimport type {PickIndexSignature} from './pick-index-signature.d.ts';\nimport type {Simplify} from './simplify.d.ts';\nimport type {If} from './if.d.ts';\nimport type {IsEqual} from './is-equal.d.ts';\n\n// Merges two objects without worrying about index signatures.\ntype SimpleMerge<Destination, Source> = Simplify<{\n\t[Key in keyof Destination as Key extends keyof Source ? never : Key]: Destination[Key];\n} & Source>;\n\n/**\nMerge two types into a new type. Keys of the second type overrides keys of the first type.\n\nThis is different from the TypeScript `&` (intersection) operator. With `&`, conflicting property types are intersected, which often results in `never`. For example, `{a: string} & {a: number}` makes `a` become `string & number`, which resolves to `never`. With `Merge`, the second type's keys cleanly override the first, so `Merge<{a: string}, {a: number}>` gives `{a: number}` as expected. `Merge` also produces a flattened type (via `Simplify`), making it more readable in IDE tooltips compared to `A & B`.\n\n@example\n```\nimport type {Merge} from 'type-fest';\n\ntype Foo = {\n\ta: string;\n\tb: number;\n};\n\ntype Bar = {\n\ta: number; // Conflicts with Foo['a']\n\tc: boolean;\n};\n\n// With `&`, `a` becomes `string & number` which is `never`. Not what you want.\ntype WithIntersection = (Foo & Bar)['a'];\n//=> never\n\n// With `Merge`, `a` is cleanly overridden to `number`.\ntype WithMerge = Merge<Foo, Bar>['a'];\n//=> number\n```\n\n@example\n```\nimport type {Merge} from 'type-fest';\n\ntype Foo = {\n\t[x: string]: unknown;\n\t[x: number]: unknown;\n\tfoo: string;\n\tbar: symbol;\n};\n\ntype Bar = {\n\t[x: number]: number;\n\t[x: symbol]: unknown;\n\tbar: Date;\n\tbaz: boolean;\n};\n\nexport type FooBar = Merge<Foo, Bar>;\n//=> {\n// \t[x: string]: unknown;\n// \t[x: number]: number;\n// \t[x: symbol]: unknown;\n// \tfoo: string;\n// \tbar: Date;\n// \tbaz: boolean;\n// }\n```\n\nNote: If you want a merge type that more accurately reflects the runtime behavior of object spread or `Object.assign`, refer to the {@link ObjectMerge} type.\n\n@see {@link ObjectMerge}\n@category Object\n*/\nexport type Merge<Destination, Source> =\n\tDestination extends unknown // For distributing `Destination`\n\t\t? Source extends unknown // For distributing `Source`\n\t\t\t? If<IsEqual<Destination, Source>, Destination, _Merge<Destination, Source>>\n\t\t\t: never // Should never happen\n\t\t: never; // Should never happen\n\nexport type _Merge<Destination, Source> =\n\tSimplify<\n\t\tSimpleMerge<PickIndexSignature<Destination>, PickIndexSignature<Source>>\n\t\t& SimpleMerge<OmitIndexSignature<Destination>, OmitIndexSignature<Source>>\n\t>;\n\nexport {};\n","import type {Simplify} from '../simplify.d.ts';\nimport type {IsEqual} from '../is-equal.d.ts';\nimport type {KeysOfUnion} from '../keys-of-union.d.ts';\nimport type {RequiredKeysOf} from '../required-keys-of.d.ts';\nimport type {Merge} from '../merge.d.ts';\nimport type {OptionalKeysOf} from '../optional-keys-of.d.ts';\nimport type {IsAny} from '../is-any.d.ts';\nimport type {If} from '../if.d.ts';\nimport type {IsNever} from '../is-never.d.ts';\nimport type {FilterDefinedKeys, FilterOptionalKeys} from './keys.d.ts';\nimport type {MapsSetsOrArrays, NonRecursiveType} from './type.d.ts';\nimport type {StringToNumber, ToString} from './string.d.ts';\n\n/**\nCreate an object type with the given key `<Key>` and value `<Value>`.\n\nIt will copy the prefix and optional status of the same key from the given object `CopiedFrom` into the result.\n\n@example\n```\ntype A = BuildObject<'a', string>;\n//=> {a: string}\n\n// Copy `readonly` and `?` from the key `a` of `{readonly a?: any}`\ntype B = BuildObject<'a', string, {readonly a?: any}>;\n//=> {readonly a?: string}\n```\n*/\nexport type BuildObject<Key extends PropertyKey, Value, CopiedFrom extends object = {}> =\n\tKey extends keyof CopiedFrom\n\t\t? Pick<{[_ in keyof CopiedFrom]: Value}, Key>\n\t\t: Key extends `${infer NumberKey extends number}`\n\t\t\t? NumberKey extends keyof CopiedFrom\n\t\t\t\t? Pick<{[_ in keyof CopiedFrom]: Value}, NumberKey>\n\t\t\t\t: {[_ in Key]: Value}\n\t\t\t: {[_ in Key]: Value};\n\n/**\nReturns a boolean for whether the given type is a plain key-value object.\n*/\nexport type IsPlainObject<T> =\n\tIsNever<T> extends true\n\t\t? false\n\t\t: T extends NonRecursiveType | MapsSetsOrArrays\n\t\t\t? false\n\t\t\t: T extends object\n\t\t\t\t? true\n\t\t\t\t: false;\n\n/**\nExtract the object field type if T is an object and K is a key of T, return `never` otherwise.\n\nIt creates a type-safe way to access the member type of `unknown` type.\n*/\nexport type ObjectValue<T, K> =\n\tK extends keyof T\n\t\t? T[K]\n\t\t: ToString<K> extends keyof T\n\t\t\t? T[ToString<K>]\n\t\t\t: K extends `${infer NumberK extends number}`\n\t\t\t\t? NumberK extends keyof T\n\t\t\t\t\t? T[NumberK]\n\t\t\t\t\t: never\n\t\t\t\t: never;\n\n/**\nFor an object T, if it has any properties that are a union with `undefined`, make those into optional properties instead.\n\n@example\n```\ntype User = {\n\tfirstName: string;\n\tlastName: string | undefined;\n};\n\ntype OptionalizedUser = UndefinedToOptional<User>;\n//=> {\n// \tfirstName: string;\n// \tlastName?: string;\n// }\n```\n*/\nexport type UndefinedToOptional<T extends object> = Simplify<\n\t{\n\t// Property is not a union with `undefined`, keep it as-is.\n\t\t[Key in keyof Pick<T, FilterDefinedKeys<T>>]: T[Key];\n\t} & {\n\t// Property _is_ a union with defined value. Set as optional (via `?`) and remove `undefined` from the union.\n\t\t[Key in keyof Pick<T, FilterOptionalKeys<T>>]?: Exclude<T[Key], undefined>;\n\t}\n>;\n\n/**\nWorks similar to the built-in `Pick` utility type, except for the following differences:\n- Distributes over union types and allows picking keys from any member of the union type.\n- Primitives types are returned as-is.\n- Picks all keys if `Keys` is `any`.\n- Doesn't pick `number` from a `string` index signature.\n\n@example\n```\ntype ImageUpload = {\n\turl: string;\n\tsize: number;\n\tthumbnailUrl: string;\n};\n\ntype VideoUpload = {\n\turl: string;\n\tduration: number;\n\tencodingFormat: string;\n};\n\n// Distributes over union types and allows picking keys from any member of the union type\ntype MediaDisplay = HomomorphicPick<ImageUpload | VideoUpload, \"url\" | \"size\" | \"duration\">;\n//=> {url: string; size: number} | {url: string; duration: number}\n\n// Primitive types are returned as-is\ntype Primitive = HomomorphicPick<string | number, 'toUpperCase' | 'toString'>;\n//=> string | number\n\n// Picks all keys if `Keys` is `any`\ntype Any = HomomorphicPick<{a: 1; b: 2} | {c: 3}, any>;\n//=> {a: 1; b: 2} | {c: 3}\n\n// Doesn't pick `number` from a `string` index signature\ntype IndexSignature = HomomorphicPick<{[k: string]: unknown}, number>;\n//=> {}\n*/\nexport type HomomorphicPick<T, Keys extends KeysOfUnion<T>> = {\n\t[P in keyof T as Extract<P, Keys>]: T[P]\n};\n\n/**\nExtract all possible values for a given key from a union of object types.\n\n@example\n```\ntype Statuses = ValueOfUnion<{id: 1; status: 'open'} | {id: 2; status: 'closed'}, 'status'>;\n//=> \"open\" | \"closed\"\n```\n*/\nexport type ValueOfUnion<Union, Key extends KeysOfUnion<Union>> =\n\tUnion extends unknown ? Key extends keyof Union ? Union[Key] : never : never;\n\n/**\nExtract all readonly keys from a union of object types.\n\n@example\n```\ntype User = {\n\treadonly id: string;\n\tname: string;\n};\n\ntype Post = {\n\treadonly id: string;\n\treadonly author: string;\n\tbody: string;\n};\n\ntype ReadonlyKeys = ReadonlyKeysOfUnion<User | Post>;\n//=> \"id\" | \"author\"\n```\n*/\nexport type ReadonlyKeysOfUnion<Union> = Union extends unknown ? keyof {\n\t[Key in keyof Union as IsEqual<{[K in Key]: Union[Key]}, {readonly [K in Key]: Union[Key]}> extends true ? Key : never]: never\n} : never;\n\n/**\nMerges user specified options with default options.\n\n@example\n```\ntype PathsOptions = {maxRecursionDepth?: number; leavesOnly?: boolean};\ntype DefaultPathsOptions = {maxRecursionDepth: 10; leavesOnly: false};\ntype SpecifiedOptions = {leavesOnly: true};\n\ntype Result = ApplyDefaultOptions<PathsOptions, DefaultPathsOptions, SpecifiedOptions>;\n//=> {maxRecursionDepth: 10; leavesOnly: true}\n```\n\n@example\n```\n// Complains if default values are not provided for optional options\n\ntype PathsOptions = {maxRecursionDepth?: number; leavesOnly?: boolean};\ntype DefaultPathsOptions = {maxRecursionDepth: 10};\ntype SpecifiedOptions = {};\n\ntype Result = ApplyDefaultOptions<PathsOptions, DefaultPathsOptions, SpecifiedOptions>;\n// ~~~~~~~~~~~~~~~~~~~\n// Property 'leavesOnly' is missing in type 'DefaultPathsOptions' but required in type '{ maxRecursionDepth: number; leavesOnly: boolean; }'.\n```\n\n@example\n```\n// Complains if an option's default type does not conform to the expected type\n\ntype PathsOptions = {maxRecursionDepth?: number; leavesOnly?: boolean};\ntype DefaultPathsOptions = {maxRecursionDepth: 10; leavesOnly: 'no'};\ntype SpecifiedOptions = {};\n\ntype Result = ApplyDefaultOptions<PathsOptions, DefaultPathsOptions, SpecifiedOptions>;\n// ~~~~~~~~~~~~~~~~~~~\n// Types of property 'leavesOnly' are incompatible. Type 'string' is not assignable to type 'boolean'.\n```\n\n@example\n```\n// Complains if an option's specified type does not conform to the expected type\n\ntype PathsOptions = {maxRecursionDepth?: number; leavesOnly?: boolean};\ntype DefaultPathsOptions = {maxRecursionDepth: 10; leavesOnly: false};\ntype SpecifiedOptions = {leavesOnly: 'yes'};\n\ntype Result = ApplyDefaultOptions<PathsOptions, DefaultPathsOptions, SpecifiedOptions>;\n// ~~~~~~~~~~~~~~~~\n// Types of property 'leavesOnly' are incompatible. Type 'string' is not assignable to type 'boolean'.\n```\n*/\nexport type ApplyDefaultOptions<\n\tOptions extends object,\n\tDefaults extends Simplify<Omit<Required<Options>, RequiredKeysOf<Options>> & Partial<Record<RequiredKeysOf<Options>, never>>>,\n\tSpecifiedOptions extends Options,\n> =\n\tIf<IsAny<SpecifiedOptions>, Defaults,\n\t\tIf<IsNever<SpecifiedOptions>, Defaults,\n\t\t\tSimplify<Merge<Defaults, {\n\t\t\t\t[Key in keyof SpecifiedOptions\n\t\t\t\tas Key extends OptionalKeysOf<Options> ? undefined extends SpecifiedOptions[Key] ? never : Key : Key\n\t\t\t\t]: SpecifiedOptions[Key]\n\t\t\t}> & Required<Options>>>>; // `& Required<Options>` ensures that `ApplyDefaultOptions<SomeOption, ...>` is always assignable to `Required<SomeOption>`\n\n/**\nCollapses literal types in a union into their corresponding primitive types, when possible. For example, `CollapseLiterals<'foo' | 'bar' | (string & {})>` returns `string`.\n\nNote: This doesn't collapse literals within tagged types. For example, `CollapseLiterals<Tagged<'foo' | (string & {}), 'Tag'>>` returns `(\"foo\" & Tag<\"Tag\", never>) | (string & Tag<\"Tag\", never>)` and not `string & Tag<\"Tag\", never>`.\n\nUse-case: For collapsing unions created using {@link LiteralUnion}.\n\n@example\n```\nimport type {LiteralUnion} from 'type-fest';\n\ntype A = CollapseLiterals<'foo' | 'bar' | (string & {})>;\n//=> string\n\ntype B = CollapseLiterals<LiteralUnion<1 | 2 | 3, number>>;\n//=> number\n\ntype C = CollapseLiterals<LiteralUnion<'onClick' | 'onChange', `on${string}`>>;\n//=> `on${string}`\n\ntype D = CollapseLiterals<'click' | 'change' | (`on${string}` & {})>;\n//=> 'click' | 'change' | `on${string}`\n\ntype E = CollapseLiterals<LiteralUnion<'foo' | 'bar', string> | null | undefined>;\n//=> string | null | undefined\n```\n*/\nexport type CollapseLiterals<T> = {} extends T\n\t? T\n\t: T extends infer U & {}\n\t\t? U\n\t\t: T;\n\n/**\nNormalize keys by including string and number representations wherever applicable.\n\n@example\n```ts\ntype A = NormalizedKeys<0 | '1'>;\n//=> 0 | '0' | 1 | '1'\n\ntype B = NormalizedKeys<string>;\n//=> string | number\n\ntype C = NormalizedKeys<number>;\n//=> number | `${number}`\n\ntype D = NormalizedKeys<symbol | 'foo'>;\n//=> symbol | 'foo'\n```\n*/\nexport type NormalizedKeys<Keys extends PropertyKey> =\n\t| Keys\n\t| (string extends Keys ? number : never)\n\t| StringToNumber<Keys & string>\n\t| ToString<Keys & number>;\n\nexport {};\n","import type {ApplyDefaultOptions} from './internal/index.d.ts';\nimport type {IsEqual} from './is-equal.d.ts';\n\n/**\nFilter out keys from an object.\n\nReturns `never` if `Exclude` is strictly equal to `Key`.\nReturns `never` if `Key` extends `Exclude`.\nReturns `Key` otherwise.\n\n@example\n```\ntype Filtered = Filter<'foo', 'foo'>;\n//=> never\n```\n\n@example\n```\ntype Filtered = Filter<'bar', string>;\n//=> never\n```\n\n@example\n```\ntype Filtered = Filter<'bar', 'foo'>;\n//=> 'bar'\n```\n\n@see {Except}\n*/\ntype Filter<KeyType, ExcludeType> = IsEqual<KeyType, ExcludeType> extends true ? never : (KeyType extends ExcludeType ? never : KeyType);\n\nexport type ExceptOptions = {\n\t/**\n\tDisallow assigning non-specified properties.\n\n\tNote that any omitted properties in the resulting type will be present in autocomplete as `undefined`.\n\n\t@default false\n\t*/\n\trequireExactProps?: boolean;\n};\n\ntype DefaultExceptOptions = {\n\trequireExactProps: false;\n};\n\n/**\nCreate a type from an object type without certain keys.\n\nWe recommend setting the `requireExactProps` option to `true`.\n\nThis type is a stricter version of [`Omit`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-5.html#the-omit-helper-type). The `Omit` type does not restrict the omitted keys to be keys present on the given type, while `Except` does. The benefits of a stricter type are avoiding typos and allowing the compiler to pick up on rename refactors automatically.\n\nThis type was proposed to the TypeScript team, which declined it, saying they prefer that libraries implement stricter versions of the built-in types ([microsoft/TypeScript#30825](https://github.com/microsoft/TypeScript/issues/30825#issuecomment-523668235)).\n\n@example\n```\nimport type {Except} from 'type-fest';\n\ntype Foo = {\n\ta: number;\n\tb: string;\n};\n\ntype FooWithoutA = Except<Foo, 'a'>;\n//=> {b: string}\n\n// @ts-expect-error\nconst fooWithoutA: FooWithoutA = {a: 1, b: '2'};\n// errors: 'a' does not exist in type '{ b: string; }'\n\ntype FooWithoutB = Except<Foo, 'b', {requireExactProps: true}>;\n//=> {a: number} & Partial<Record<'b', never>>\n\n// @ts-expect-error\nconst fooWithoutB: FooWithoutB = {a: 1, b: '2'};\n// errors at 'b': Type 'string' is not assignable to type 'undefined'.\n\n// The `Omit` utility type doesn't work when omitting specific keys from objects containing index signatures.\n\n// Consider the following example:\n\ntype UserData = {\n\t[metadata: string]: string;\n\temail: string;\n\tname: string;\n\trole: 'admin' | 'user';\n};\n\n// `Omit` clearly doesn't behave as expected in this case:\ntype PostPayload = Omit<UserData, 'email'>;\n//=> {[x: string]: string; [x: number]: string}\n\n// In situations like this, `Except` works better.\n// It simply removes the `email` key while preserving all the other keys.\ntype PostPayloadFixed = Except<UserData, 'email'>;\n//=> {[x: string]: string; name: string; role: 'admin' | 'user'}\n```\n\n@category Object\n*/\nexport type Except<ObjectType, KeysType extends keyof ObjectType, Options extends ExceptOptions = {}> =\n\t_Except<ObjectType, KeysType, ApplyDefaultOptions<ExceptOptions, DefaultExceptOptions, Options>>;\n\ntype _Except<ObjectType, KeysType extends keyof ObjectType, Options extends Required<ExceptOptions>> = {\n\t[KeyType in keyof ObjectType as Filter<KeyType, KeysType>]: ObjectType[KeyType];\n} & (Options['requireExactProps'] extends true\n\t? Partial<Record<KeysType, never>>\n\t: {});\n\nexport {};\n"],"x_google_ignoreList":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16],"mappings":";;AAiBA;;;;;;;;;ACsBA;;;;;;;KDtBYA;;AEWZ;;AFPCC;;AGqBD;AAAA,EAAmEW,CAAAA,gBAAAA,EHlB5CX,KGkB4CW,EAAAA,GAAAA;AAC5DA;AAAAA,EAAOC;AAAbH;AACGG;AAAAA,CAAkBD,SAAAA,CAAAA,CAAAA,kBAAAA,EAAAA,KAAAA,aAAAA,EAAAA,GAAAA,IAAAA;AACjBA;AAAAA,EHdFV,YGcsBW,GHdPZ,KGcOY,GAAKD,KAAAA;;;;;;;;;;;AFN9B;;;;;;;;;ACXA;;;;ACcA;;;;;;;;;;;;;;;;ACPYI,KHIAZ,WGJc,CAAA,UAAAa,CAAAA;AACzBA;AACyBA,MHIlBd,mBGJkBc,CHIEZ,UGJFY,SAAAA,OAAAA,GHI+BX,MGJ/BW,CAAAA,MHI4CZ,UGJ5CY,EAAAA,KAAAA,CAAAA,GAAAA,KAAAA,CAAAA;;;;AJpB1B;;;;;;;;;ACsBA;;;;;;;;;ACXA;;;;ACcA;;;;;AAEIJ,KDhBQN,KCgBRM,CAAAA,CAAAA,CAAAA,GAAAA,CAAAA,SAAAA,CAAAA,GDhBiCJ,OCgBjCI,CDhByCL,CCgBzCK,CAAAA,GAAAA,IAAAA,GAAAA,KAAAA;;;;;;;;;;;AFLJ;;;;;;;;;ACXA;;;;ACcA;;;;;;;;;;;;;;;;ACPA;;;AAGmBI,KDIPN,eCJOM,CAAAA,aAAAA,MAAAA,EAAAA,cAAAA,MDIgDL,ICJhDK,CAAAA,GDKlBP,KCLwBQ,CDKlBN,ICLkBM,GDKXL,KCLWK,CAAAA,SAAAA,IAAAA,GAAAA,KAAAA,GDMrBL,KCNDE,SAAAA,MDMmBH,ICNnBG,GDOEH,ICLCM,SDKYJ,MCLZI,CDKmBL,KCLnBK,EDKwBN,ICLxBM,CDK6BL,KCL7BK,CAAAA,CAAAA,GAEOD,KAAAA,GAAI,IAAA;;;;;;;;;;;AHHjB;;;;;;;;;ACXA;;;;ACcA;;;;;;;;;;;;AAGwB,KCVZD,cDUY,CAAA,aAAA,MAAA,CAAA,GCTvBC;yBACyBA,QACvBF,gBAAgBE,MAAMC,qBAHbF,KAAAA,GAKNE,GAJLD,GACyBA,KAAAA,EACPA,CAAAA,GAAAA,MAINA,IAJMA,CAAAA;AAAAA,EAAMC,KAAAA;;;;;;;;;;;AHCzB;;;;;;;;;ACXA;;;;ACcA;;;;;;;;;AAG8BN,KEblBQ,cFakBR,CAAAA,aAAAA,MAAAA,CAAAA,GEZ7BS,IFYkCR,SAAAA,OAAAA,CAAAA;AAAAA,EEX/BS,OFWcR,CAAAA,MEXAO,IFWAP,EEXMK,cFWNL,CEXqBO,IFWrBP,CAAAA,CAAAA,GAAM,KAAA;;;;AH5BxB;;;;;;;;;ACsBA;;;;;;;;;ACXA;;;;ACcA;;;;;;;;;;;;;;;;ACPA;;;;;;;;;;;;ACHA;;AAEkBO,KCmBNE,ODnBMF,CAAAA,CAAAA,CAAAA,GAAAA,CCmBQG,CDnBRH,CAAAA,SAAAA,CAAAA,KAAAA,CAAAA,GAAAA,IAAAA,GAAAA,KAAAA;;;;;;;;;;;AJKlB;;;;;;;;;ACXA;;;;ACcA;;;;;;;;;;;;;;;;ACPA;;;;;;;;;;;;ACHA;;;;;;;;;;ACqBA;;;;ACyCA;;;;;;;;;;;ACtEA;;;;AC0DA;AAkDA;;;;;;;;;;;AA4BA;;KFlEYK,iDACXD,QAAQE,qBACLE,UGtCQmC,GHuCRrC,IGvCyCsC,SAAAA,IAAAA,GHwCxCrC,QGxC4CqC,GHyC5CpC,UGzC8CqC;;;;AVzCnD;;;;;;;;;ACsBA;;;;;;;;;ACXA;;;;ACcA;AAAmEtD,KKlBvDkB,YAAAA,GLkBuDlB,SAAAA,OAAAA,EAAAA;;;;;;;;;AKlBnE;;;;AC0DA;AAkDA;AACU0C,KAnDEG,GAmDFH,CAAAA,UAAAA,OAAAA,CAAAA,GAnD2BI,CAmD3BJ,SAAAA,IAAAA,GAANtB,KAAAA,GAjDD0B,CAiDWE,SAAAA,KAAAA,GAAkBN,IAAAA,GAARrB,KAAAA;;;;;AA2BxB;;;;ACtGA;;;;;;;;AChCA;;;;;;;;;AAKU;;;;;;;;;;;;;AC4DV;;;;;;AAGyByC,KHsCbf,eGtCae,CAAAA,CAAAA,EAAAA,iBAAAA,EAAAA,QAAAA,GAAAA,EAAAA,UAAAA,KAAAA,CAAAA,GHuCxB3C,EGvC+B,CHuC5BC,KGvC4B,CHuCtBsB,CGvCsB,CAAA,EHuClBM,KGvCkB,EHuCX7B,EGvCW,CHuCRE,OGvCQ,CHuCAqB,CGvCA,CAAA,EHuCIO,OGvCJ,EHuCaF,iBGvCb,CAAA,CAAA;;AErBhC;;AAEI4B,KLqFQxB,mCAAAA,GKrFRwB,CAAAA,CAAAA,MAAAA,GAAAA,SAAAA,CAAAA,CAAAA,CAAAA,SAAAA,CAAAA,MAAAA,CAAAA,CAAAA,GACYD,KAAAA,GAAaC,IAAAA;;;;Ad3D7B;;;;;;;;;ACsBA;;;;;;;;;ACXA;;;;ACcA;;;;;;;;;;;;;;;;ACPA;;;;;;;;;;;;ACHA;;;;;;;KK0BYvB,kCAAiCC,IAAIA,EAAEC;;;;AVzCnD;;;;;;;;;ACsBA;;;;;;;;;ACXA;;;;ACcA;;;AACcrD,KQjBFsD,ORiBEtD,CAAAA,CAAAA,EAAAA,CAAAA,CAAAA,GAAbH,CQhBC0D,CRgBD1D,CAAAA,SAAAA,CQhBa2D,CRgBb3D,CAAAA,GACGG,CQhBCwD,CRgBDxD,CAAAA,SAAAA,CQhBauD,CRgBbvD,CAAAA,GQfCyD,QReiB1D,CQfRwD,CReQxD,EQfLyD,CReKzD,CAAAA,GACjBA,KAAAA,GAAoBC,KAAAA;;KQXpByD,QRWaxD,CAAAA,CAAAA,EAAAA,CAAAA,CAAAA,GAAM,CAAA,CAAA,CAAA,CAAA,GAAA,GQVbyD,CRUa,SQVHH,CRUG,GQVCG,CRUD,GQVKA,CRUL,GAAA,CAAA,GAAA,CAAA,CAAA,mBQTbA,UAAUF,IAAIE,IAAIA;;;;AXnB7B;;;;;;;;;ACsBA;;;;;;;;;ACXA;;;;ACcA;;;;;;;;;;;;;;;;ACPA;;;;;;;;;;;;ACHA;;;;;;;;;;ACqBA;;;;ACyCA;;;;;;;;;;;ACtEA;;;;AC0DA;AAkDA;;;;;;;;;;AACG,KG1CSC,kBH0CT,CAAA,UAAA,CAAA,GAAA,cA2BST,MGpEOU,UHoEPV,IAAAA,CAAAA,CAAAA,SGpEgCY,MHoEG,CGpEID,OHoEJ,EAAA,OAAA,CAAA,WGlE3CA,UAAUD,WAAWC;;;;AZ7EzB;;;;;;;;;ACsBA;;;;;;;;;ACXA;;;;ACcA;;;;;;;;;;;;;;;;ACPA;;;;;;AAKMxD,KSKM0D,kBTLN1D,CAAAA,UAAAA,CAAAA,GAAAA,cAEOD,MSIM4D,UTJN5D,IAAAA,CAAAA,CAAAA,SSI+B8D,MTJ/B9D,CSIsC6D,OTJtC7D,EAAAA,OAAAA,CAAAA,GSKT6D,OTLa,WSMLD,WAAWC;;;;KCzClBO,mCAAmCH,yBACzBI,eAAeE,kBAAkBD,iBAAiBC,MAAMF,YAAYE,SAC/ED;;;;;;;;;;AZmBJ;;;;ACcA;;;;;;;;;;;;;;;;ACPA;;;;;;;;;;;;ACHA;;;;;;;;;;ACqBA;;;;ACyCA;;;;;;;;KOrBYE,6BACXH;EACGC;EACCJ,ENpDOrD,CMoDJsD,ONpDItD,CMoDIwD,WNpDQ,EMoDKC,MNpDL,CAAA,EMoDcD,WNpDd,EMoD2BI,MNpD3B,CMoDkCJ,WNpDlC,EMoD+CC,MNpD/C,CAAA,CAAA;;;;AC0DZ9B,KKFAiC,MLEGhC,CAAAA,WAEX,EAAA,MAAA,CAAA,GKHHwB,QLmDWvB,CKlDV0B,WLmDQ/B,CKnDI2B,kBLmDJ3B,CKnDuBgC,WLmDvBhC,CAAAA,EKnDqC2B,kBLmDrC3B,CKnDwDiC,MLmDxDjC,CAAAA,CAAAA,GKlDN+B,WLkDArD,CKlDYgD,kBLkDZhD,CKlD+BsD,WLkD/BtD,CAAAA,EKlD6CgD,kBLkD7ChD,CKlDgEuD,MLkDhEvD,CAAAA,CAAAA,CAAU4B;;;AA2Bd;;;;ACtGA;;;;;;;;AChCA;;;;;;;;;AAKU;;;;;;;;;;;;;AC4DV;;;AAC4Ce,KGqChC6C,eHrCgC7C,CAAAA,CAAAA,EAAAA,aGqCAkB,WHrCAlB,CGqCYuC,CHrCZvC,CAAAA,CAAAA,GAAAA,QAExCD,MGoCSwC,CHpCTxC,IGoCciD,OHpCdjD,CGoCsBgD,CHpCtBhD,EGoCyB+C,IHpCzB/C,CAAAA,GGoCiCwC,CHpCjCxC,CGoCmCgD,CHpCnChD,CAAAA,EAAUD;;AEdd;;;;;;;;;;;;;;;;ACiDA;;;;;;;;;;AA4FA;;;;;;;;;;;;;;;;;;;;;;;;;AAS+FkC,KATnFoB,mBASmFpB,CAAMA,gBAAAA,MAAAA,EAC9FuB,iBARWvC,QAQXuC,CARoBE,IAQpBF,CARyBC,QAQzBD,CARkCF,OAQlCE,CAAAA,EAR4CpC,cAQ5CoC,CAR2DF,OAQ3DE,CAAAA,CAAAA,GARuEI,OAQvEJ,CAR+EG,MAQ/EH,CARsFpC,cAQtFoC,CARqGF,OAQrGE,CAAAA,EAAAA,KAAAA,CAAAA,CAAAA,CAAAA,EAAiBvB,yBAPEqB,OAOFrB,CAHZZ,GAFXG,EAMgB8B,CANb/B,KAMa+B,CANPE,gBAMOF,CAAAA,EANYC,QAMZD,EALf9B,EAKMiC,CALHhC,OAKGgC,CALKD,gBAKLC,CAAAA,EALwBF,QAKxBE,EAJLxC,QAAAA,CAASI,KAATJ,CAAesC,QAAftC,EAAAA,UADDO,MAEgBgC,gBAFhBhC,IAGKS,GAJNT,SAIkBF,cAJlBE,CAIiC8B,OAJjC9B,CAAAA,GAAAA,SAAAA,SAI8DgC,gBAJ9DhC,CAI+ES,GAJ/ET,CAAAA,GAAAA,KAAAA,GAI8FS,GAJ9FT,GAIoGS,GAJpGT,GAKMgC,gBALJ,CAKqBvB,GALrB,CAAA,EAmCS4B,CAAAA,GA7BJJ,QA6BII,CA7BKP,OA6BW,CAAA,CAAA,CAAA,CAAA;AAAA;;;;;;;;;ACpQiB;;;;;;;;AA+B7C;AASE;AA6DF;;;;;;;;;;AACQ,KD8JIO,gBC9JJ,CAAA,CAAA,CAAA,GAAA,CAAA,CAAA,SD8JqCrB,CC9JrC,GD+JLA,CC7JEkC,GD8JFlC,CC9J6C+B,SAAAA,KAAAA,EAAAA,GAAAA,CAAAA,CAAAA,GAAqCH,CAAAA,GDgKjF5B,CChKwEmC;;;;;;;;;;AflE5E;;;;;;;;;ACXA;;;;ACcA;;;;;;;KaZKV,MbeA/H,CAAAA,SAAAA,EAAAA,WAAAA,CAAAA,Gaf+B8H,Obe/B9H,CafuCgI,SbevChI,EafgDiI,WbehDjI,CAAAA,SAAAA,IAAAA,GAAAA,KAAAA,GAAAA,CafqFgI,SberFhI,SafqGiI,WberGjI,GAAAA,KAAAA,Gaf2HgI,Sbe3HhI,CAAAA;AAAyBA,KablBkI,aAAAA,GbakBlI;EAAKC;;;;;ECTlCI,iBAAAA,CAAAA,EAAAA,OAAAA;CACyBA;KYMrB8H,oBAAAA,GZLoB7H;EAAtBH,iBAAAA,EAAAA,KAAAA;CAEGG;;;;;;ACRN;;;;;;;;;;ACqBA;;;;ACyCA;;;;;;;;;;;ACtEA;;;;AC0DA;AAkDA;;;;;;;;;;;AA4BA;;;;ACtGA;;;;;;KM4CY8H,0CAA0CC,4BAA4BH,sBACjFM,QAAQH,YAAYC,UAAUT,oBAAoBK,eAAeC,sBAAsBI;KAEnFC,OL9EHhF,CAAAA,UAAAA,EAAAA,iBAAAA,MK8E8C6E,UL9E9C7E,EAAAA,gBK8E0EiF,QL9E1EjF,CK8EmF0E,aL9EnF1E,CAAAA,CAAAA,GAAAA,cAAYC,MK+EK4E,UL/EL5E,IK+EmBsE,ML/EnBtE,CK+E0BuE,OL/E1BvE,EK+EmC6E,QL/EnC7E,CAAAA,GK+E+C4E,UL/E/C5E,CK+E0DuE,OL/E1DvE,CAAAA,EACTA,GAAAA,CK+EA8E,OL/EA9E,CAAAA,mBAAAA,CAAAA,SAAAA,IAAAA,GKgFFkF,OLhFcnF,CKgFNkF,MLhFMlF,CKgFC8E,QLhFD9E,EAAAA,KAAAA,CAAAA,CAAAA,GACHA,CAAAA,CAAAA,CAAAA"}
|
package/dist/hooks-react.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { s as BREAK_POINT_TOKEN_TYPE } from "./index-
|
|
1
|
+
import { s as BREAK_POINT_TOKEN_TYPE } from "./index-CN5K25yO.js";
|
|
2
2
|
import { r as AnyFunction, t as AnyAsyncFunction } from "./index-DBPmnr4a.js";
|
|
3
3
|
import { DependencyList, EffectCallback, RefObject } from "react";
|
|
4
4
|
|
|
5
|
-
//#region node_modules/.pnpm/type-fest@5.
|
|
5
|
+
//#region node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/tuple-to-union.d.ts
|
|
6
6
|
|
|
7
7
|
/**
|
|
8
8
|
Convert a tuple/array into a union type of its elements.
|
|
@@ -77,27 +77,59 @@ declare function useCreation<T>(factory: () => T, deps: DependencyList): T;
|
|
|
77
77
|
declare function useLatest<T>(value: T): RefObject<T>;
|
|
78
78
|
//#endregion
|
|
79
79
|
//#region src/hooks/react/useMount.d.ts
|
|
80
|
-
type MountCallback = EffectCallback | AnyAsyncFunction;
|
|
81
80
|
/**
|
|
82
81
|
* 在组件初始化时执行的 Hook
|
|
83
|
-
* -
|
|
82
|
+
* - 即使在严格模式(React StrictMode)也只执行一次
|
|
83
|
+
* - 自动使用最新版 effect 函数
|
|
84
84
|
*
|
|
85
|
-
* @param effect
|
|
85
|
+
* @param effect 副作用函数(必须为同步函数;若为异步函数,清理逻辑需自行处理)
|
|
86
|
+
* @example
|
|
87
|
+
* useMount(() => {
|
|
88
|
+
* console.log('组件挂载');
|
|
89
|
+
* return () => console.log('组件卸载');
|
|
90
|
+
* });
|
|
91
|
+
*
|
|
92
|
+
* useMount(async () => {
|
|
93
|
+
* const data = await fetchData();
|
|
94
|
+
* // 清理逻辑需通过 ref/AbortController 自行管理
|
|
95
|
+
* // ❌ 不要 return cleanupFn(async 函数返回 Promise,无法作为清理函数)
|
|
96
|
+
* });
|
|
86
97
|
*/
|
|
87
|
-
declare function useMount(effect:
|
|
98
|
+
declare function useMount(effect: EffectCallback | AnyAsyncFunction): void;
|
|
88
99
|
//#endregion
|
|
89
100
|
//#region src/hooks/react/useResponsive.d.ts
|
|
90
|
-
type Breakpoint = TupleToUnion<typeof
|
|
101
|
+
type Breakpoint = TupleToUnion<typeof BREAK_POINTS>;
|
|
91
102
|
type ResponsiveValues = Record<Breakpoint, boolean>;
|
|
92
|
-
declare const
|
|
103
|
+
declare const BREAK_POINTS: readonly ["xxxl", "xxl", "xl", "lg", "md", "sm", "xs"];
|
|
93
104
|
interface ResponsiveHookOptions {
|
|
94
105
|
/** 屏幕响应断点 token 配置 */
|
|
95
106
|
breakPointTokens?: BREAK_POINT_TOKEN_TYPE;
|
|
96
107
|
}
|
|
97
|
-
declare function useResponsive(options?: ResponsiveHookOptions): {
|
|
108
|
+
declare function useResponsive(options?: ResponsiveHookOptions | undefined): {
|
|
98
109
|
responsive: ResponsiveValues;
|
|
99
110
|
current: "xxxl" | "xxl" | "xl" | "lg" | "md" | "sm" | "xs";
|
|
100
|
-
breakPointTokens:
|
|
111
|
+
breakPointTokens: {
|
|
112
|
+
XS: 480;
|
|
113
|
+
XSMax: 575;
|
|
114
|
+
XSMin: 480;
|
|
115
|
+
SM: 576;
|
|
116
|
+
SMMax: 767;
|
|
117
|
+
SMMin: 576;
|
|
118
|
+
MD: 768;
|
|
119
|
+
MDMax: 991;
|
|
120
|
+
MDMin: 768;
|
|
121
|
+
LG: 992;
|
|
122
|
+
LGMax: 1199;
|
|
123
|
+
LGMin: 992;
|
|
124
|
+
XL: 1200;
|
|
125
|
+
XLMax: 1599;
|
|
126
|
+
XLMin: 1200;
|
|
127
|
+
XXL: 1600;
|
|
128
|
+
XXLMax: 1919;
|
|
129
|
+
XXLMin: 1600;
|
|
130
|
+
XXXL: 1920;
|
|
131
|
+
XXXLMin: 1920;
|
|
132
|
+
};
|
|
101
133
|
};
|
|
102
134
|
//#endregion
|
|
103
135
|
//#region src/hooks/react/useTitle.d.ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"hooks-react.d.ts","names":["TupleToUnion","ArrayType"],"sources":["../node_modules/.pnpm/type-fest@5.
|
|
1
|
+
{"version":3,"file":"hooks-react.d.ts","names":["TupleToUnion","ArrayType"],"sources":["../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/tuple-to-union.d.ts","../src/hooks/react/useCreation.ts","../src/hooks/react/useLatest.ts","../src/hooks/react/useMount.ts","../src/hooks/react/useResponsive.ts","../src/hooks/react/useTitle.ts","../src/hooks/react/useUnmount.ts"],"sourcesContent":["/**\nConvert a tuple/array into a union type of its elements.\n\nThis can be useful when you have a fixed set of allowed values and want a type defining only the allowed values, but do not want to repeat yourself.\n\n@example\n```\nimport type {TupleToUnion} from 'type-fest';\n\nconst destinations = ['a', 'b', 'c'] as const;\n\ntype Destination = TupleToUnion<typeof destinations>;\n//=> 'a' | 'b' | 'c'\n\nfunction verifyDestination(destination: unknown): destination is Destination {\n\treturn destinations.includes(destination as any);\n}\n\ntype RequestBody = {\n\tdeliverTo: Destination;\n};\n\nfunction verifyRequestBody(body: unknown): body is RequestBody {\n\tconst {deliverTo} = (body as any);\n\treturn typeof body === 'object' && body !== null && verifyDestination(deliverTo);\n}\n```\n\nAlternatively, you may use `typeof destinations[number]`. If `destinations` is a tuple, there is no difference. However if `destinations` is a string, the resulting type will the union of the characters in the string. Other types of `destinations` may result in a compile error. In comparison, TupleToUnion will return `never` if a tuple is not provided.\n\n@example\n```\nconst destinations = ['a', 'b', 'c'] as const;\n\ntype Destination = typeof destinations[number];\n//=> 'a' | 'b' | 'c'\n\nconst erroringType = new Set(['a', 'b', 'c']);\n\n// @ts-expect-error\ntype ErroringType = typeof erroringType[number];\n// Error: Type 'Set<string>' has no matching index signature for type 'number'. ts(2537)\n\nconst numberBool: {[n: number]: boolean} = {1: true};\n\ntype NumberBool = typeof numberBool[number];\n//=> boolean\n```\n\n@category Array\n*/\nexport type TupleToUnion<ArrayType> = ArrayType extends readonly unknown[] ? ArrayType[number] : never;\n\nexport {};\n"],"x_google_ignoreList":[0],"mappings":";;;;;;;;;;;AAmDA;;;;ACnCA;;;;;;;;ACRA;;;;;;;;ACeA;;;;ACnBgF;AAElD;AACA;AAQ9B;AAIA;;;;;ACDA;;;;ACPA;;;;;;;;;KNwCYA,0BAA0BC,uCAAuCA;;;;;;;AAA7E;;;iBCnCgB,8BAA+B,SAAS,iBAAc;;;;;;;ADmCtE;;iBE3CgB,oBAAqB,IAAI,UAAU;;;;;;AF2CnD;;;;ACnCA;;;;;;;;ACRA;;;AAAyC,iBCezB,QAAA,CDfyB,MAAA,ECeP,cDfO,GCeU,gBDfV,CAAA,EAAA,IAAA;;;KEFpC,UAAA,GAAa,oBAAoB;KACjC,gBAAA,GAAmB,OAAO;cAGzB;AJyCMD,UIpCK,qBAAA,CJoCOC;;qBIlCH;;AHDL,iBGGA,aAAA,CHHW,OAAA,CAAA,EGGc,qBHHd,GAAA,SAAA,CAAA,EAAA;EAAoB,UAAA,EGGN,gBHHM;EAAS,OAAA,EAAA,MAAA,GAAA,KAAA,GAAA,IAAA,GAAA,IAAA,GAAA,IAAA,GAAA,IAAA,GAAA,IAAA;EAAc,gBAAA,EAAA;IAAA,EAAA,EAAA,GAAA;;;;ICRtD,KAAA,EAAA,GAAS;IAAY,KAAA,EAAA,GAAA;IAAc,EAAA,EAAA,GAAA;IAAV,KAAA,EAAA,GAAA;IAAS,KAAA,EAAA,GAAA;;;;ICelC,EAAA,EAAA,IAAQ;;;;ICjBnB,MAAA,EAAA,IAAU;IACV,MAAA,EAAA,IAAA;IAGC,IAAA,EAAA,IAAA;IAKW,OAAA,EAAA,IAAA;EAID,CAAA;;;;UCfN,gBAAA;;;;;AL+CV;;;;ACnCA;;;;AAAsE,iBIEtD,QAAA,CJFsD,KAAA,EAAA,MAAA,EAAA,OAAA,CAAA,EIEnB,gBJFmB,GAAA,SAAA,CAAA,EAAA,IAAA;;;;;;;ADmCtE;;iBMxCgB,UAAA,SAAoB"}
|
package/dist/hooks-react.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { Ft as isEqual, H as isBrowser, Vt as isFunction, W as arrayZipToObject,
|
|
1
|
+
import { Ft as isEqual, H as isBrowser, T as objectMapEntries, Vt as isFunction, W as arrayZipToObject, d as stringToUpperCase, gt as isPromise, mt as isString, w as objectAssign, x as objectKeys } from "./utils-adQi5T1g.js";
|
|
2
2
|
import { i as BREAK_POINT_TOKEN_ENUM } from "./enums-BL6w5-mS.js";
|
|
3
|
-
import { useEffect, useMemo, useRef, useState } from "react";
|
|
3
|
+
import { useEffect, useLayoutEffect, useMemo, useRef, useState } from "react";
|
|
4
4
|
|
|
5
5
|
//#region src/hooks/react/useCreation.ts
|
|
6
6
|
/**
|
|
@@ -42,26 +42,41 @@ function useLatest(value) {
|
|
|
42
42
|
//#region src/hooks/react/useMount.ts
|
|
43
43
|
/**
|
|
44
44
|
* 在组件初始化时执行的 Hook
|
|
45
|
-
* -
|
|
45
|
+
* - 即使在严格模式(React StrictMode)也只执行一次
|
|
46
|
+
* - 自动使用最新版 effect 函数
|
|
46
47
|
*
|
|
47
|
-
* @param effect
|
|
48
|
+
* @param effect 副作用函数(必须为同步函数;若为异步函数,清理逻辑需自行处理)
|
|
49
|
+
* @example
|
|
50
|
+
* useMount(() => {
|
|
51
|
+
* console.log('组件挂载');
|
|
52
|
+
* return () => console.log('组件卸载');
|
|
53
|
+
* });
|
|
54
|
+
*
|
|
55
|
+
* useMount(async () => {
|
|
56
|
+
* const data = await fetchData();
|
|
57
|
+
* // 清理逻辑需通过 ref/AbortController 自行管理
|
|
58
|
+
* // ❌ 不要 return cleanupFn(async 函数返回 Promise,无法作为清理函数)
|
|
59
|
+
* });
|
|
48
60
|
*/
|
|
49
61
|
function useMount(effect) {
|
|
50
62
|
const isMountedRef = useRef(false);
|
|
51
63
|
const effectRef = useLatest(effect);
|
|
52
64
|
useEffect(() => {
|
|
53
|
-
if (!isFunction(effectRef.current))
|
|
65
|
+
if (!isFunction(effectRef.current)) {
|
|
66
|
+
console.error(`[useMount] Expected parameter to be a function, but got ${typeof effectRef.current}. This effect will not execute.`);
|
|
67
|
+
return;
|
|
68
|
+
}
|
|
54
69
|
if (isMountedRef.current) return;
|
|
55
70
|
isMountedRef.current = true;
|
|
56
|
-
const
|
|
57
|
-
|
|
58
|
-
return result;
|
|
71
|
+
const cleanup = effectRef.current?.();
|
|
72
|
+
return isFunction(cleanup) && !isPromise(cleanup) ? cleanup : void 0;
|
|
59
73
|
}, [effectRef]);
|
|
60
74
|
}
|
|
61
75
|
|
|
62
76
|
//#endregion
|
|
63
77
|
//#region src/hooks/react/useResponsive.ts
|
|
64
|
-
const
|
|
78
|
+
const SUBSCRIBER_SET = /* @__PURE__ */ new Set();
|
|
79
|
+
const BREAK_POINTS = [
|
|
65
80
|
"xxxl",
|
|
66
81
|
"xxl",
|
|
67
82
|
"xl",
|
|
@@ -70,41 +85,24 @@ const tuple = [
|
|
|
70
85
|
"sm",
|
|
71
86
|
"xs"
|
|
72
87
|
];
|
|
73
|
-
const
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
"XL",
|
|
77
|
-
"LG",
|
|
78
|
-
"MD",
|
|
79
|
-
"SM",
|
|
80
|
-
"XS"
|
|
81
|
-
];
|
|
82
|
-
const defaultValues = arrayZipToObject(tuple, tuple.map(() => false));
|
|
88
|
+
const DEFAULT_VALUES = Object.freeze(arrayZipToObject(BREAK_POINTS, false));
|
|
89
|
+
let responsiveValues = { ...DEFAULT_VALUES };
|
|
90
|
+
let responsiveTokens = BREAK_POINT_TOKEN_ENUM;
|
|
83
91
|
function useResponsive(options) {
|
|
84
92
|
const { breakPointTokens = {} } = options || {};
|
|
85
|
-
const responsiveValuesRef = useRef({ ...defaultValues });
|
|
86
|
-
const [responsive, setResponsive] = useState({ ...defaultValues });
|
|
87
93
|
const tokens = useMemo(() => objectAssign(BREAK_POINT_TOKEN_ENUM, breakPointTokens), [breakPointTokens]);
|
|
88
|
-
const
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
const responsiveConfig = arrayZipToObject(tuple, TUPLE.map((t) => tokens[t]));
|
|
93
|
-
let shouldUpdate = false;
|
|
94
|
-
for (const key of tuple) {
|
|
95
|
-
newValues[key] = window.innerWidth >= responsiveConfig[key];
|
|
96
|
-
if (newValues[key] !== responsiveValuesRef.current[key]) shouldUpdate = true;
|
|
97
|
-
}
|
|
98
|
-
if (shouldUpdate) responsiveValuesRef.current = newValues;
|
|
99
|
-
}
|
|
100
|
-
function resizeListener() {
|
|
101
|
-
const oldInfo = responsiveValuesRef.current;
|
|
102
|
-
calculate();
|
|
103
|
-
if (oldInfo !== responsiveValuesRef.current) setResponsive(responsiveValuesRef.current);
|
|
104
|
-
}
|
|
94
|
+
const [responsive, setResponsive] = useState(() => calculateResponsive(tokens));
|
|
95
|
+
const current = objectKeys(DEFAULT_VALUES).find((key) => responsive[key] === true) || "xs";
|
|
96
|
+
useLayoutEffect(() => {
|
|
97
|
+
responsiveTokens = tokens;
|
|
105
98
|
window.addEventListener("resize", resizeListener);
|
|
99
|
+
const subscriber = () => {
|
|
100
|
+
setResponsive(responsiveValues);
|
|
101
|
+
};
|
|
102
|
+
SUBSCRIBER_SET.add(subscriber);
|
|
106
103
|
return () => {
|
|
107
|
-
|
|
104
|
+
SUBSCRIBER_SET.delete(subscriber);
|
|
105
|
+
if (!SUBSCRIBER_SET.size) window.removeEventListener("resize", resizeListener);
|
|
108
106
|
};
|
|
109
107
|
}, [tokens]);
|
|
110
108
|
return {
|
|
@@ -113,6 +111,17 @@ function useResponsive(options) {
|
|
|
113
111
|
breakPointTokens: tokens
|
|
114
112
|
};
|
|
115
113
|
}
|
|
114
|
+
function resizeListener() {
|
|
115
|
+
const newValues = calculateResponsive(responsiveTokens);
|
|
116
|
+
if (!isEqual(responsiveValues, newValues)) {
|
|
117
|
+
responsiveValues = newValues;
|
|
118
|
+
for (const subscriber of SUBSCRIBER_SET) subscriber();
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
function calculateResponsive(tokens) {
|
|
122
|
+
const config = arrayZipToObject(BREAK_POINTS, BREAK_POINTS.map((t) => tokens[stringToUpperCase(t)]));
|
|
123
|
+
return objectMapEntries(DEFAULT_VALUES, (key) => [key, window.innerWidth >= config[key]]);
|
|
124
|
+
}
|
|
116
125
|
|
|
117
126
|
//#endregion
|
|
118
127
|
//#region src/hooks/react/useUnmount.ts
|
package/dist/hooks-react.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"hooks-react.js","names":["
|
|
1
|
+
{"version":3,"file":"hooks-react.js","names":["DEFAULT_VALUES: ResponsiveValues","responsiveValues: ResponsiveValues","responsiveTokens: BREAK_POINT_TOKEN_TYPE"],"sources":["../src/hooks/react/useCreation.ts","../src/hooks/react/useLatest.ts","../src/hooks/react/useMount.ts","../src/hooks/react/useResponsive.ts","../src/hooks/react/useUnmount.ts","../src/hooks/react/useTitle.ts"],"sourcesContent":["import { useRef, type DependencyList } from \"react\";\nimport { isEqual } from \"src/utils\";\n\ninterface RefObject<T> {\n deps: DependencyList;\n result: T;\n isInitialized: boolean;\n}\n\n/**\n * useCreation\n * @reference https://ahooks.js.org/zh-CN/hooks/use-creation\n *\n * @param factory\n * @param deps\n */\nexport function useCreation<T> (factory: () => T, deps: DependencyList) {\n const { current } = useRef<RefObject<T>>({ deps, result: undefined!, isInitialized: false });\n\n if (current.isInitialized === false || !isEqual(current.deps, deps)) {\n current.deps = deps;\n current.result = factory();\n current.isInitialized = true;\n }\n\n return current.result;\n}\n","import { useRef, type RefObject } from \"react\";\n\n/**\n * 返回当前最新值的 Hook\n * @reference https://ahooks.js.org/zh-CN/hooks/use-latest\n *\n * @param value\n */\nexport function useLatest<T> (value: T): RefObject<T> {\n const ref = useRef(value);\n // eslint-disable-next-line react-x/refs\n ref.current = value;\n\n return ref;\n}\n","import { useEffect, useRef, type EffectCallback } from \"react\";\nimport { isFunction, isPromise } from \"src/utils\";\nimport { useLatest } from \"./useLatest\";\nimport type { AnyAsyncFunction } from \"@pawover/types\";\n\n/**\n * 在组件初始化时执行的 Hook\n * - 即使在严格模式(React StrictMode)也只执行一次\n * - 自动使用最新版 effect 函数\n *\n * @param effect 副作用函数(必须为同步函数;若为异步函数,清理逻辑需自行处理)\n * @example\n * useMount(() => {\n * console.log('组件挂载');\n * return () => console.log('组件卸载');\n * });\n *\n * useMount(async () => {\n * const data = await fetchData();\n * // 清理逻辑需通过 ref/AbortController 自行管理\n * // ❌ 不要 return cleanupFn(async 函数返回 Promise,无法作为清理函数)\n * });\n */\nexport function useMount (effect: EffectCallback | AnyAsyncFunction) {\n const isMountedRef = useRef(false);\n const effectRef = useLatest(effect);\n\n useEffect(() => {\n if (!isFunction(effectRef.current)) {\n console.error(`[useMount] Expected parameter to be a function, but got ${typeof effectRef.current}. This effect will not execute.`);\n\n return;\n }\n if (isMountedRef.current) {\n return;\n }\n\n isMountedRef.current = true;\n const cleanup = effectRef.current?.();\n\n return isFunction(cleanup) && !isPromise(cleanup) ? cleanup : undefined;\n }, [effectRef]);\n}\n","import type { AnyFunction } from \"@pawover/types\";\nimport { arrayZipToObject, objectAssign, objectKeys, stringToUpperCase, objectMapEntries, isEqual } from \"../../utils\";\nimport { useMemo, useState, useLayoutEffect } from \"react\";\nimport type { TupleToUnion } from \"type-fest\";\nimport { BREAK_POINT_TOKEN_ENUM, type BREAK_POINT_TOKEN_TYPE } from \"src/enums\";\n\ntype Breakpoint = TupleToUnion<typeof BREAK_POINTS>;\ntype ResponsiveValues = Record<Breakpoint, boolean>;\n\nconst SUBSCRIBER_SET = new Set<AnyFunction>();\nconst BREAK_POINTS = [\"xxxl\", \"xxl\", \"xl\", \"lg\", \"md\", \"sm\", \"xs\"] as const;\nconst DEFAULT_VALUES: ResponsiveValues = Object.freeze(arrayZipToObject(BREAK_POINTS, false));\nlet responsiveValues: ResponsiveValues = { ...DEFAULT_VALUES };\nlet responsiveTokens: BREAK_POINT_TOKEN_TYPE = BREAK_POINT_TOKEN_ENUM;\n\nexport interface ResponsiveHookOptions {\n /** 屏幕响应断点 token 配置 */\n breakPointTokens?: BREAK_POINT_TOKEN_TYPE;\n}\nexport function useResponsive (options?: ResponsiveHookOptions | undefined) {\n const { breakPointTokens = {} } = options || {};\n const tokens = useMemo(() => objectAssign(BREAK_POINT_TOKEN_ENUM, breakPointTokens), [breakPointTokens]);\n const [responsive, setResponsive] = useState<ResponsiveValues>(() => calculateResponsive(tokens));\n const current = objectKeys(DEFAULT_VALUES).find((key) => responsive[key] === true) || \"xs\";\n\n useLayoutEffect(() => {\n responsiveTokens = tokens;\n window.addEventListener(\"resize\", resizeListener);\n\n const subscriber = () => {\n setResponsive(responsiveValues);\n };\n\n SUBSCRIBER_SET.add(subscriber);\n\n return () => {\n SUBSCRIBER_SET.delete(subscriber);\n\n if (!SUBSCRIBER_SET.size) {\n window.removeEventListener(\"resize\", resizeListener);\n }\n };\n }, [tokens]);\n\n return { responsive, current, breakPointTokens: tokens };\n}\n\nfunction resizeListener () {\n const newValues = calculateResponsive(responsiveTokens);\n\n if (!isEqual(responsiveValues, newValues)) {\n responsiveValues = newValues;\n\n for (const subscriber of SUBSCRIBER_SET) {\n subscriber();\n }\n }\n}\n\nfunction calculateResponsive (tokens: BREAK_POINT_TOKEN_TYPE) {\n const config = arrayZipToObject(BREAK_POINTS, BREAK_POINTS.map((t) => tokens[stringToUpperCase(t)]));\n\n return objectMapEntries(DEFAULT_VALUES, (key) => [key, window.innerWidth >= config[key]]);\n}\n","import type { AnyFunction } from \"@pawover/types\";\nimport { useEffect } from \"react\";\nimport { isFunction } from \"src/utils\";\nimport { useLatest } from \"./useLatest\";\n\n/**\n * 在组件卸载时执行的 Hook\n * @reference https://ahooks.js.org/zh-CN/hooks/use-unmount\n *\n * @param effect 副作用函数\n */\nexport function useUnmount (effect: AnyFunction) {\n const effectRef = useLatest(effect);\n\n useEffect(\n () => () => {\n if (!isFunction(effectRef.current)) {\n console.error(`useUnmount expected parameter is a function, but got ${typeof effectRef.current}`);\n\n return;\n }\n effectRef.current?.();\n },\n [effectRef],\n );\n}\n","import { useEffect, useRef } from \"react\";\nimport { isBrowser, isString } from \"../../utils\";\nimport { useUnmount } from \"./useUnmount\";\n\ninterface TitleHookOptions {\n /** 件卸载时是否恢复原始标题 */\n isRestoreOnUnmount?: boolean;\n}\n\n/**\n * 设置页面标题\n * - 轻量级,适用于无路由库时设置页面标题\n * - 多个 `useTitle` 实例会互相干扰,需在顶层组件使用\n * - 无法处理 `document.title` 固有的竞态问题\n *\n * @param title 页面标题\n * @param options 配置选项\n */\nexport function useTitle (title: string, options?: TitleHookOptions | undefined) {\n const titleRef = useRef(isBrowser() ? document.title : \"\");\n\n useEffect(() => {\n if (!isString(title)) {\n console.error(`useTitle expected title is a string, but got ${typeof title}`);\n\n return;\n }\n if (isBrowser()) {\n document.title = title;\n }\n }, [title]);\n\n useUnmount(() => {\n if (isBrowser() && options?.isRestoreOnUnmount) {\n document.title = titleRef.current;\n }\n });\n}\n"],"mappings":";;;;;;;;;;;;AAgBA,SAAgB,YAAgB,SAAkB,MAAsB;CACtE,MAAM,EAAE,YAAY,OAAqB;EAAE;EAAM,QAAQ;EAAY,eAAe;EAAO,CAAC;AAE5F,KAAI,QAAQ,kBAAkB,SAAS,CAAC,QAAQ,QAAQ,MAAM,KAAK,EAAE;AACnE,UAAQ,OAAO;AACf,UAAQ,SAAS,SAAS;AAC1B,UAAQ,gBAAgB;;AAG1B,QAAO,QAAQ;;;;;;;;;;;ACjBjB,SAAgB,UAAc,OAAwB;CACpD,MAAM,MAAM,OAAO,MAAM;AAEzB,KAAI,UAAU;AAEd,QAAO;;;;;;;;;;;;;;;;;;;;;;;ACUT,SAAgB,SAAU,QAA2C;CACnE,MAAM,eAAe,OAAO,MAAM;CAClC,MAAM,YAAY,UAAU,OAAO;AAEnC,iBAAgB;AACd,MAAI,CAAC,WAAW,UAAU,QAAQ,EAAE;AAClC,WAAQ,MAAM,2DAA2D,OAAO,UAAU,QAAQ,iCAAiC;AAEnI;;AAEF,MAAI,aAAa,QACf;AAGF,eAAa,UAAU;EACvB,MAAM,UAAU,UAAU,WAAW;AAErC,SAAO,WAAW,QAAQ,IAAI,CAAC,UAAU,QAAQ,GAAG,UAAU;IAC7D,CAAC,UAAU,CAAC;;;;;AChCjB,MAAM,iCAAiB,IAAI,KAAkB;AAC7C,MAAM,eAAe;CAAC;CAAQ;CAAO;CAAM;CAAM;CAAM;CAAM;CAAK;AAClE,MAAMA,iBAAmC,OAAO,OAAO,iBAAiB,cAAc,MAAM,CAAC;AAC7F,IAAIC,mBAAqC,EAAE,GAAG,gBAAgB;AAC9D,IAAIC,mBAA2C;AAM/C,SAAgB,cAAe,SAA6C;CAC1E,MAAM,EAAE,mBAAmB,EAAE,KAAK,WAAW,EAAE;CAC/C,MAAM,SAAS,cAAc,aAAa,wBAAwB,iBAAiB,EAAE,CAAC,iBAAiB,CAAC;CACxG,MAAM,CAAC,YAAY,iBAAiB,eAAiC,oBAAoB,OAAO,CAAC;CACjG,MAAM,UAAU,WAAW,eAAe,CAAC,MAAM,QAAQ,WAAW,SAAS,KAAK,IAAI;AAEtF,uBAAsB;AACpB,qBAAmB;AACnB,SAAO,iBAAiB,UAAU,eAAe;EAEjD,MAAM,mBAAmB;AACvB,iBAAc,iBAAiB;;AAGjC,iBAAe,IAAI,WAAW;AAE9B,eAAa;AACX,kBAAe,OAAO,WAAW;AAEjC,OAAI,CAAC,eAAe,KAClB,QAAO,oBAAoB,UAAU,eAAe;;IAGvD,CAAC,OAAO,CAAC;AAEZ,QAAO;EAAE;EAAY;EAAS,kBAAkB;EAAQ;;AAG1D,SAAS,iBAAkB;CACzB,MAAM,YAAY,oBAAoB,iBAAiB;AAEvD,KAAI,CAAC,QAAQ,kBAAkB,UAAU,EAAE;AACzC,qBAAmB;AAEnB,OAAK,MAAM,cAAc,eACvB,aAAY;;;AAKlB,SAAS,oBAAqB,QAAgC;CAC5D,MAAM,SAAS,iBAAiB,cAAc,aAAa,KAAK,MAAM,OAAO,kBAAkB,EAAE,EAAE,CAAC;AAEpG,QAAO,iBAAiB,iBAAiB,QAAQ,CAAC,KAAK,OAAO,cAAc,OAAO,KAAK,CAAC;;;;;;;;;;;ACnD3F,SAAgB,WAAY,QAAqB;CAC/C,MAAM,YAAY,UAAU,OAAO;AAEnC,uBACc;AACV,MAAI,CAAC,WAAW,UAAU,QAAQ,EAAE;AAClC,WAAQ,MAAM,wDAAwD,OAAO,UAAU,UAAU;AAEjG;;AAEF,YAAU,WAAW;IAEvB,CAAC,UAAU,CACZ;;;;;;;;;;;;;;ACNH,SAAgB,SAAU,OAAe,SAAwC;CAC/E,MAAM,WAAW,OAAO,WAAW,GAAG,SAAS,QAAQ,GAAG;AAE1D,iBAAgB;AACd,MAAI,CAAC,SAAS,MAAM,EAAE;AACpB,WAAQ,MAAM,gDAAgD,OAAO,QAAQ;AAE7E;;AAEF,MAAI,WAAW,CACb,UAAS,QAAQ;IAElB,CAAC,MAAM,CAAC;AAEX,kBAAiB;AACf,MAAI,WAAW,IAAI,SAAS,mBAC1B,UAAS,QAAQ,SAAS;GAE5B"}
|