Skip to content

types: improve readability of built-in type #9129

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
May 30, 2024
Merged

types: improve readability of built-in type #9129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
94a81b6
feat(types): better hints for built in types
Mini-ghost Sep 4, 2023
c2b674f
types: use `Builtin` instead of `Function` and `Date`
Mini-ghost Sep 5, 2023
83b0fee
chore: remove duplicate types
Mini-ghost Sep 5, 2023
9a0676c
Merge branch 'main' into type/support-date-type
yyx990803 Dec 11, 2023
57dc127
types: use `Primitive` to instead of `BaseType`
Mini-ghost Dec 11, 2023
ea3ce88
Revert "types: use `Primitive` to instead of `BaseType`"
Mini-ghost Dec 11, 2023
d36bac4
Merge branch 'main' into type/support-date-type
Mini-ghost Mar 4, 2024
e32c9e2
Merge branch 'main' into type/support-date-type
Mini-ghost Apr 29, 2024
b72fbff
Merge branch 'main' into type/support-date-type
yyx990803 May 30, 2024
f9432d6
Merge branch 'main' into type/support-date-type
yyx990803 May 30, 2024
cd44800
[autofix.ci] apply automated fixes
autofix-ci[bot] May 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/reactivity/src/reactive.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ export function shallowReactive<T extends object>(
}

type Primitive = string | number | boolean | bigint | symbol | undefined | null
type Builtin = Primitive | Function | Date | Error | RegExp
export type Builtin = Primitive | Function | Date | Error | RegExp
export type DeepReadonly<T> = T extends Builtin
? T
: T extends Map<infer K, infer V>
Expand Down
10 changes: 2 additions & 8 deletions packages/reactivity/src/ref.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import {
toRaw,
toReactive,
} from './reactive'
import type { ShallowReactiveMarker } from './reactive'
import type { Builtin, ShallowReactiveMarker } from './reactive'
import { type Dep, createDep } from './dep'
import { ComputedRefImpl } from './computed'
import { getDepFromReactive } from './reactiveEffect'
Expand Down Expand Up @@ -475,11 +475,6 @@ function propertyToRef(
: (new ObjectRefImpl(source, key, defaultValue) as any)
}

// corner case when use narrows type
// Ex. type RelativePath = string & { __brand: unknown }
// RelativePath extends object -> true
type BaseTypes = string | number | boolean

/**
* This is a special exported interface for other packages to declare
* additional types that should bail out for ref unwrapping. For example
Expand Down Expand Up @@ -509,8 +504,7 @@ export type UnwrapRef<T> =
: UnwrapRefSimple<T>

export type UnwrapRefSimple<T> = T extends
| Function
| BaseTypes
| Builtin
| Ref
| RefUnwrapBailTypes[keyof RefUnwrapBailTypes]
| { [RawSymbol]?: true }
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime-core/src/compat/instance.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,11 @@ export interface LegacyPublicProperties {
$set<T extends Record<keyof any, any>, K extends keyof T>(
target: T,
key: K,
value: T[K]
value: T[K],
): void
$delete<T extends Record<keyof any, any>, K extends keyof T>(
target: T,
key: K
key: K,
): void
$mount(el?: string | Element): this
$destroy(): void
Expand Down