macros.d.ts 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  1. import {
  2. Ref,
  3. UnwrapRef,
  4. ComputedRef,
  5. WritableComputedOptions,
  6. DebuggerOptions,
  7. WritableComputedRef,
  8. CustomRefFactory
  9. } from '@vue/runtime-dom'
  10. export declare const RefType: unique symbol
  11. export declare const enum RefTypes {
  12. Ref = 1,
  13. ComputedRef = 2,
  14. WritableComputedRef = 3
  15. }
  16. type RefValue<T> = T extends null | undefined
  17. ? T
  18. : T & { [RefType]?: RefTypes.Ref }
  19. type ComputedRefValue<T> = T extends null | undefined
  20. ? T
  21. : T & { [RefType]?: RefTypes.ComputedRef }
  22. type WritableComputedRefValue<T> = T extends null | undefined
  23. ? T
  24. : T & { [RefType]?: RefTypes.WritableComputedRef }
  25. type NormalObject<T extends object> = T & { [RefType]?: never }
  26. /**
  27. * Vue ref transform macro for binding refs as reactive variables.
  28. */
  29. export declare function $<T>(arg: ComputedRef<T>): ComputedRefValue<T>
  30. export declare function $<T>(
  31. arg: WritableComputedRef<T>
  32. ): WritableComputedRefValue<T>
  33. export declare function $<T>(arg: Ref<T>): RefValue<T>
  34. export declare function $<T extends object>(arg?: T): DestructureRefs<T>
  35. type DestructureRefs<T extends object> = {
  36. [K in keyof T]: T[K] extends ComputedRef<infer V>
  37. ? ComputedRefValue<V>
  38. : T[K] extends WritableComputedRef<infer V>
  39. ? WritableComputedRefValue<V>
  40. : T[K] extends Ref<infer V>
  41. ? RefValue<V>
  42. : T[K]
  43. }
  44. /**
  45. * Vue ref transform macro for accessing underlying refs of reactive varaibles.
  46. */
  47. export declare function $$<T extends object>(arg: NormalObject<T>): ToRawRefs<T>
  48. export declare function $$<T>(value: RefValue<T>): Ref<T>
  49. export declare function $$<T>(value: ComputedRefValue<T>): ComputedRef<T>
  50. export declare function $$<T>(
  51. value: WritableComputedRefValue<T>
  52. ): WritableComputedRef<T>
  53. type ToRawRefs<T extends object> = {
  54. [K in keyof T]: T[K] extends RefValue<infer V>
  55. ? Ref<V>
  56. : T[K] extends ComputedRefValue<infer V>
  57. ? ComputedRef<V>
  58. : T[K] extends WritableComputedRefValue<infer V>
  59. ? WritableComputedRef<V>
  60. : T[K] extends object
  61. ? T[K] extends
  62. | Function
  63. | Map<any, any>
  64. | Set<any>
  65. | WeakMap<any, any>
  66. | WeakSet<any>
  67. ? T[K]
  68. : ToRawRefs<T[K]>
  69. : T[K]
  70. }
  71. export declare function $ref<T>(arg?: T | Ref<T>): RefValue<UnwrapRef<T>>
  72. export declare function $shallowRef<T>(arg?: T): RefValue<T>
  73. export declare function $toRef<T extends object, K extends keyof T>(
  74. object: T,
  75. key: K
  76. ): RefValue<T[K]>
  77. export declare function $toRef<T extends object, K extends keyof T>(
  78. object: T,
  79. key: K,
  80. defaultValue: T[K]
  81. ): RefValue<Exclude<T[K], undefined>>
  82. export declare function $customRef<T>(factory: CustomRefFactory<T>): RefValue<T>
  83. export declare function $computed<T>(
  84. getter: () => T,
  85. debuggerOptions?: DebuggerOptions
  86. ): ComputedRefValue<T>
  87. export declare function $computed<T>(
  88. options: WritableComputedOptions<T>,
  89. debuggerOptions?: DebuggerOptions
  90. ): WritableComputedRefValue<T>