@reactive-vscode/reactivity 1.0.0-beta.2 → 1.0.1

package/dist/index.d.ts

@@ -1,5 +1,7 @@
 export declare const ARRAY_ITERATE_KEY: unique symbol;
 
+export declare type ArrayStringKey<T> = T extends readonly any[] ? number extends T['length'] ? `${number}` : never : never;
+
 export declare interface BaseComputedRef<T, S = T> extends Ref<T, S> {
     [ComputedRefSymbol]: true;
     /**
@@ -79,11 +81,11 @@ export declare type ComputedSetter<T> = (newValue: T) => void;
  * @param factory - The function that receives the `track` and `trigger` callbacks.
  * @see {@link https://vuejs.org/api/reactivity-advanced.html#customref}
  */
-export declare function customRef<T>(factory: CustomRefFactory<T>): Ref<T>;
+export declare function customRef<T, S = T>(factory: CustomRefFactory<T, S>): Ref<T, S>;
 
-export declare type CustomRefFactory<T> = (track: () => void, trigger: () => void) => {
+export declare type CustomRefFactory<T, S = T> = (track: () => void, trigger: () => void) => {
     get: () => T;
-    set: (value: T) => void;
+    set: (value: S) => void;
 };
 
 export declare type DebuggerEvent = {
@@ -131,6 +133,7 @@ export declare type EffectScheduler = (...args: any[]) => any;
 export declare class EffectScope {
     detached: boolean;
     private _isPaused;
+    readonly __v_skip = true;
     constructor(detached?: boolean);
     get active(): boolean;
     pause(): void;
@@ -473,9 +476,7 @@ export declare interface RefUnwrapBailTypes {
  */
 export declare function resetTracking(): void;
 
-export declare type ShallowReactive<T> = T & {
-    [ShallowReactiveMarker]?: true;
-};
+export declare type ShallowReactive<T> = T & ShallowReactiveBrand;
 
 /**
  * Shallow version of {@link reactive}.
@@ -509,7 +510,11 @@ export declare type ShallowReactive<T> = T & {
  */
 export declare function shallowReactive<T extends object>(target: T): ShallowReactive<T>;
 
-export declare const ShallowReactiveMarker: unique symbol;
+export declare type ShallowReactiveBrand = ShallowReactiveBrandClass;
+
+export declare class ShallowReactiveBrandClass {
+    private __shallowReactiveBrand?;
+}
 
 /**
  * Track array iteration and return raw array
@@ -575,7 +580,7 @@ export declare function shallowRef<T = any>(): ShallowRef<T | undefined>;
 
 export declare const ShallowRefMarker: unique symbol;
 
-export declare type ShallowUnwrapRef<T> = {
+export declare type ShallowUnwrapRef<T> = T extends ShallowReactiveBrand ? T : {
     [K in keyof T]: DistributeRef<T[K]>;
 };
 
@@ -682,9 +687,11 @@ export declare type ToRef<T> = IfAny<T, Ref<T>, [T] extends [Ref] ? T : Ref<T>>;
  */
 export declare function toRef<T>(value: T): T extends () => infer R ? Readonly<Ref<R>> : T extends Ref ? T : Ref<UnwrapRef<T>>;
 
-export declare function toRef<T extends object, K extends keyof T>(object: T, key: K): ToRef<T[K]>;
+export declare function toRef<T extends object, K extends ToRefKey<T>>(object: T, key: K): ToRef<ToRefValue<T, K>>;
+
+export declare function toRef<T extends object, K extends ToRefKey<T>>(object: T, key: K, defaultValue: ToRefValue<T, K>): ToRef<Exclude<ToRefValue<T, K>, undefined>>;
 
-export declare function toRef<T extends object, K extends keyof T>(object: T, key: K, defaultValue: T[K]): ToRef<Exclude<T[K], undefined>>;
+export declare type ToRefKey<T> = keyof T | ArrayStringKey<T>;
 
 export declare type ToRefs<T = any> = {
     [K in keyof T]: ToRef<T[K]>;
@@ -700,6 +707,8 @@ export declare type ToRefs<T = any> = {
  */
 export declare function toRefs<T extends object>(object: T): ToRefs<T>;
 
+export declare type ToRefValue<T extends object, K extends ToRefKey<T>> = K extends keyof T ? T[K] : T extends readonly (infer V)[] ? K extends ArrayStringKey<T> ? V : never : never;
+
 /**
  * Normalizes values / refs / getters to values.
  * This is similar to {@link unref}, except that it also normalizes getters.
@@ -806,11 +815,9 @@ export declare type UnwrapRef<T> = T extends ShallowRef<infer V, unknown> ? V :
 
 export declare type UnwrapRefSimple<T> = T extends Builtin | Ref | RefUnwrapBailTypes[keyof RefUnwrapBailTypes] | {
     [RawSymbol]?: true;
-} ? T : T extends Map<infer K, infer V> ? Map<K, UnwrapRefSimple<V>> & UnwrapRef<Omit<T, keyof Map<any, any>>> : T extends WeakMap<infer K, infer V> ? WeakMap<K, UnwrapRefSimple<V>> & UnwrapRef<Omit<T, keyof WeakMap<any, any>>> : T extends Set<infer V> ? Set<UnwrapRefSimple<V>> & UnwrapRef<Omit<T, keyof Set<any>>> : T extends WeakSet<infer V> ? WeakSet<UnwrapRefSimple<V>> & UnwrapRef<Omit<T, keyof WeakSet<any>>> : T extends ReadonlyArray<any> ? {
+} ? T : T extends ShallowReactiveBrand ? T : T extends Map<infer K, infer V> ? Map<K, UnwrapRefSimple<V>> & UnwrapRef<Omit<T, keyof Map<any, any>>> : T extends WeakMap<infer K, infer V> ? WeakMap<K, UnwrapRefSimple<V>> & UnwrapRef<Omit<T, keyof WeakMap<any, any>>> : T extends Set<infer V> ? Set<UnwrapRefSimple<V>> & UnwrapRef<Omit<T, keyof Set<any>>> : T extends WeakSet<infer V> ? WeakSet<UnwrapRefSimple<V>> & UnwrapRef<Omit<T, keyof WeakSet<any>>> : T extends ReadonlyArray<any> ? {
     [K in keyof T]: UnwrapRefSimple<T[K]>;
-} : T extends object & {
-    [ShallowReactiveMarker]?: never;
-} ? {
+} : T extends object ? {
     [P in keyof T]: P extends symbol ? T[P] : UnwrapRef<T[P]>;
 } : T;