defu - npm Package Compare versions

Comparing version 6.0.1 to 6.1.0

dist/defu.d.ts

@@ -8,6 +8,6 @@ declare type Input = Record<string | number | symbol, any>;
 };
-declare type Coalesce<S extends Input, D extends Array<Input | IgnoredInput>> = D extends [infer F, ...infer Rest] ? F extends Input ? Coalesce<MergeObjects<S, F>, Rest> : F extends IgnoredInput ? Coalesce<S, Rest> : S : S;
-declare type DefuFn = <Source extends Input, Defaults extends Array<Input | IgnoredInput>>(source: Source, ...defaults: Defaults) => Coalesce<Source, Defaults>;
-interface Defu {
-    <Source extends Input, Defaults extends Array<Input | IgnoredInput>>(source: Source | IgnoredInput, ...defaults: Defaults): Coalesce<Source, Defaults>;
+declare type Defu<S extends Input, D extends Array<Input | IgnoredInput>> = D extends [infer F, ...infer Rest] ? F extends Input ? Rest extends Array<Input | IgnoredInput> ? Defu<MergeObjects<S, F>, Rest> : MergeObjects<S, F> : F extends IgnoredInput ? Rest extends Array<Input | IgnoredInput> ? Defu<S, Rest> : S : S : S;
+declare type DefuFn = <Source extends Input, Defaults extends Array<Input | IgnoredInput>>(source: Source, ...defaults: Defaults) => Defu<Source, Defaults>;
+interface DefuInstance {
+    <Source extends Input, Defaults extends Array<Input | IgnoredInput>>(source: Source | IgnoredInput, ...defaults: Defaults): Defu<Source, Defaults>;
     fn: DefuFn;
@@ -21,3 +21,3 @@ arrayFn: DefuFn;
 declare function createDefu(merger?: Merger): DefuFn;
-declare const defu: Defu;
+declare const defu: DefuInstance;
 
@@ -27,2 +27,2 @@ declare const defuFn: DefuFn;
 
-export { createDefu, defu as default, defu, defuArrayFn, defuFn };
+export { Defu, createDefu, defu as default, defu, defuArrayFn, defuFn };

package.json

 {
   "name": "defu",
-  "version": "6.0.1",
+  "version": "6.1.0",
   "description": "Recursively assign default properties. Lightweight and Fast!",
@@ -5,0 +5,0 @@ "repository": "unjs/defu",

README.md

@@ -144,2 +144,13 @@ ![defu](.github/banner.svg)
 
+## Type
+
+We expose `Defu` as a type utility to return a merged type that follows the rules that defu follows.
+
+```js
+import type { Defu } from 'defu'
+
+type Options = Defu<{ foo: 'bar' }, [{}, { bar: 'baz' }, { something: 42 }]>
+// returns { foo: 'bar', bar: 'baz', 'something': 42 }
+```
+
 ## License
@@ -146,0 +157,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

12569

increased by3.3%

Lines of code

123

increased by0.82%

Number of lines in readme file

177

increased by6.63%

No dependency changes