Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: add typing to allow for non-objects input args #42

Merged
merged 3 commits into from Aug 8, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Expand Up @@ -21,5 +21,6 @@ jobs:
- run: pnpm install
- run: pnpm lint
- run: pnpm build
- run: pnpm test:types
- run: pnpm vitest --coverage
- uses: codecov/codecov-action@v2
3 changes: 2 additions & 1 deletion package.json
Expand Up @@ -22,7 +22,8 @@
"lint": "eslint --ext .ts src",
"prepack": "pnpm build",
"release": "pnpm test && standard-version && git push --follow-tags && pnpm publish",
"test": "pnpm lint && pnpm vitest"
"test": "pnpm lint && pnpm vitest",
"test:types": "tsc --noEmit"
},
"devDependencies": {
"@nuxtjs/eslint-config-typescript": "latest",
Expand Down
4 changes: 3 additions & 1 deletion src/types.ts
Expand Up @@ -29,8 +29,10 @@ export type DefuFn = <Source extends Input, Defaults extends Input>(
...defaults: Defaults[]
) => MergeObjects<Source, Defaults>;

type HandledNonObject = boolean | number | null | any[] | undefined
pi0 marked this conversation as resolved.
Show resolved Hide resolved

export interface Defu {
<Source extends Input, Defaults extends Input>(source: Source, ...defaults: Defaults[]): MergeObjects<
<Source extends Input, Defaults extends Input>(source: Source | HandledNonObject, ...defaults: Array<Defaults | HandledNonObject>): MergeObjects<
Source,
Defaults
>;
Expand Down
3 changes: 0 additions & 3 deletions test/defu.test.ts
Expand Up @@ -58,14 +58,12 @@ describe('defu', () => {

it('should handle non object first param', () => {
for (const val of nonObject) {
// @ts-expect-error
expect(defu(val, { d: true })).toEqual({ d: true })
}
})

it('should handle non object second param', () => {
for (const val of nonObject) {
// @ts-expect-error
expect(defu({ d: true }, val)).toEqual({ d: true })
}
})
Expand All @@ -92,7 +90,6 @@ describe('defu', () => {
})

it('should ignore non-object arguments', () => {
// @ts-expect-error
expect(defu(null, { foo: 1 }, false, 123, { bar: 2 })).toEqual({
foo: 1,
bar: 2
Expand Down
5 changes: 4 additions & 1 deletion tsconfig.json
Expand Up @@ -2,9 +2,12 @@
"compilerOptions": {
"target": "ESNext",
"module": "ESNext",
"moduleResolution": "node",
"skipLibCheck": true,
"declaration": true
},
"include": [
"src"
"src",
"test"
]
}