shared.d.ts 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334
  1. /**
  2. * Make a map and return a function for checking if a key
  3. * is in that map.
  4. * IMPORTANT: all calls of this function must be prefixed with
  5. * \/\*#\_\_PURE\_\_\*\/
  6. * So that rollup can tree-shake them if necessary.
  7. */
  8. export declare function makeMap(str: string): (key: string) => boolean;
  9. export declare const EMPTY_OBJ: {
  10. readonly [key: string]: any;
  11. };
  12. export declare const EMPTY_ARR: readonly never[];
  13. export declare const NOOP: () => void;
  14. /**
  15. * Always return false.
  16. */
  17. export declare const NO: () => boolean;
  18. export declare const isOn: (key: string) => boolean;
  19. export declare const isModelListener: (key: string) => key is `onUpdate:${string}`;
  20. export declare const extend: typeof Object.assign;
  21. export declare const remove: <T>(arr: T[], el: T) => void;
  22. export declare const hasOwn: (val: object, key: string | symbol) => key is keyof typeof val;
  23. export declare const isArray: typeof Array.isArray;
  24. export declare const isMap: (val: unknown) => val is Map<any, any>;
  25. export declare const isSet: (val: unknown) => val is Set<any>;
  26. export declare const isDate: (val: unknown) => val is Date;
  27. export declare const isRegExp: (val: unknown) => val is RegExp;
  28. export declare const isFunction: (val: unknown) => val is Function;
  29. export declare const isString: (val: unknown) => val is string;
  30. export declare const isSymbol: (val: unknown) => val is symbol;
  31. export declare const isObject: (val: unknown) => val is Record<any, any>;
  32. export declare const isPromise: <T = any>(val: unknown) => val is Promise<T>;
  33. export declare const objectToString: typeof Object.prototype.toString;
  34. export declare const toTypeString: (value: unknown) => string;
  35. export declare const toRawType: (value: unknown) => string;
  36. export declare const isPlainObject: (val: unknown) => val is object;
  37. export declare const isIntegerKey: (key: unknown) => boolean;
  38. export declare const isReservedProp: (key: string) => boolean;
  39. export declare const isBuiltInDirective: (key: string) => boolean;
  40. /**
  41. * @private
  42. */
  43. export declare const camelize: (str: string) => string;
  44. /**
  45. * @private
  46. */
  47. export declare const hyphenate: (str: string) => string;
  48. /**
  49. * @private
  50. */
  51. export declare const capitalize: <T extends string>(str: T) => Capitalize<T>;
  52. /**
  53. * @private
  54. */
  55. export declare const toHandlerKey: <T extends string>(str: T) => T extends '' ? '' : `on${Capitalize<T>}`;
  56. export declare const hasChanged: (value: any, oldValue: any) => boolean;
  57. export declare const invokeArrayFns: (fns: Function[], ...arg: any[]) => void;
  58. export declare const def: (obj: object, key: string | symbol, value: any, writable?: boolean) => void;
  59. /**
  60. * "123-foo" will be parsed to 123
  61. * This is used for the .number modifier in v-model
  62. */
  63. export declare const looseToNumber: (val: any) => any;
  64. /**
  65. * Only concerns number-like strings
  66. * "123-foo" will be returned as-is
  67. */
  68. export declare const toNumber: (val: any) => any;
  69. export declare const getGlobalThis: () => any;
  70. export declare function genPropsAccessExp(name: string): string;
  71. export declare function genCacheKey(source: string, options: any): string;
  72. /**
  73. * Patch flags are optimization hints generated by the compiler.
  74. * when a block with dynamicChildren is encountered during diff, the algorithm
  75. * enters "optimized mode". In this mode, we know that the vdom is produced by
  76. * a render function generated by the compiler, so the algorithm only needs to
  77. * handle updates explicitly marked by these patch flags.
  78. *
  79. * Patch flags can be combined using the | bitwise operator and can be checked
  80. * using the & operator, e.g.
  81. *
  82. * ```js
  83. * const flag = TEXT | CLASS
  84. * if (flag & TEXT) { ... }
  85. * ```
  86. *
  87. * Check the `patchElement` function in '../../runtime-core/src/renderer.ts' to see how the
  88. * flags are handled during diff.
  89. */
  90. export declare enum PatchFlags {
  91. /**
  92. * Indicates an element with dynamic textContent (children fast path)
  93. */
  94. TEXT = 1,
  95. /**
  96. * Indicates an element with dynamic class binding.
  97. */
  98. CLASS = 2,
  99. /**
  100. * Indicates an element with dynamic style
  101. * The compiler pre-compiles static string styles into static objects
  102. * + detects and hoists inline static objects
  103. * e.g. `style="color: red"` and `:style="{ color: 'red' }"` both get hoisted
  104. * as:
  105. * ```js
  106. * const style = { color: 'red' }
  107. * render() { return e('div', { style }) }
  108. * ```
  109. */
  110. STYLE = 4,
  111. /**
  112. * Indicates an element that has non-class/style dynamic props.
  113. * Can also be on a component that has any dynamic props (includes
  114. * class/style). when this flag is present, the vnode also has a dynamicProps
  115. * array that contains the keys of the props that may change so the runtime
  116. * can diff them faster (without having to worry about removed props)
  117. */
  118. PROPS = 8,
  119. /**
  120. * Indicates an element with props with dynamic keys. When keys change, a full
  121. * diff is always needed to remove the old key. This flag is mutually
  122. * exclusive with CLASS, STYLE and PROPS.
  123. */
  124. FULL_PROPS = 16,
  125. /**
  126. * Indicates an element that requires props hydration
  127. * (but not necessarily patching)
  128. * e.g. event listeners & v-bind with prop modifier
  129. */
  130. NEED_HYDRATION = 32,
  131. /**
  132. * Indicates a fragment whose children order doesn't change.
  133. */
  134. STABLE_FRAGMENT = 64,
  135. /**
  136. * Indicates a fragment with keyed or partially keyed children
  137. */
  138. KEYED_FRAGMENT = 128,
  139. /**
  140. * Indicates a fragment with unkeyed children.
  141. */
  142. UNKEYED_FRAGMENT = 256,
  143. /**
  144. * Indicates an element that only needs non-props patching, e.g. ref or
  145. * directives (onVnodeXXX hooks). since every patched vnode checks for refs
  146. * and onVnodeXXX hooks, it simply marks the vnode so that a parent block
  147. * will track it.
  148. */
  149. NEED_PATCH = 512,
  150. /**
  151. * Indicates a component with dynamic slots (e.g. slot that references a v-for
  152. * iterated value, or dynamic slot names).
  153. * Components with this flag are always force updated.
  154. */
  155. DYNAMIC_SLOTS = 1024,
  156. /**
  157. * Indicates a fragment that was created only because the user has placed
  158. * comments at the root level of a template. This is a dev-only flag since
  159. * comments are stripped in production.
  160. */
  161. DEV_ROOT_FRAGMENT = 2048,
  162. /**
  163. * SPECIAL FLAGS -------------------------------------------------------------
  164. * Special flags are negative integers. They are never matched against using
  165. * bitwise operators (bitwise matching should only happen in branches where
  166. * patchFlag > 0), and are mutually exclusive. When checking for a special
  167. * flag, simply check patchFlag === FLAG.
  168. */
  169. /**
  170. * Indicates a cached static vnode. This is also a hint for hydration to skip
  171. * the entire sub tree since static content never needs to be updated.
  172. */
  173. CACHED = -1,
  174. /**
  175. * A special flag that indicates that the diffing algorithm should bail out
  176. * of optimized mode. For example, on block fragments created by renderSlot()
  177. * when encountering non-compiler generated slots (i.e. manually written
  178. * render functions, which should always be fully diffed)
  179. * OR manually cloneVNodes
  180. */
  181. BAIL = -2
  182. }
  183. /**
  184. * dev only flag -> name mapping
  185. */
  186. export declare const PatchFlagNames: Record<PatchFlags, string>;
  187. export declare enum ShapeFlags {
  188. ELEMENT = 1,
  189. FUNCTIONAL_COMPONENT = 2,
  190. STATEFUL_COMPONENT = 4,
  191. TEXT_CHILDREN = 8,
  192. ARRAY_CHILDREN = 16,
  193. SLOTS_CHILDREN = 32,
  194. TELEPORT = 64,
  195. SUSPENSE = 128,
  196. COMPONENT_SHOULD_KEEP_ALIVE = 256,
  197. COMPONENT_KEPT_ALIVE = 512,
  198. COMPONENT = 6
  199. }
  200. export declare enum SlotFlags {
  201. /**
  202. * Stable slots that only reference slot props or context state. The slot
  203. * can fully capture its own dependencies so when passed down the parent won't
  204. * need to force the child to update.
  205. */
  206. STABLE = 1,
  207. /**
  208. * Slots that reference scope variables (v-for or an outer slot prop), or
  209. * has conditional structure (v-if, v-for). The parent will need to force
  210. * the child to update because the slot does not fully capture its dependencies.
  211. */
  212. DYNAMIC = 2,
  213. /**
  214. * `<slot/>` being forwarded into a child component. Whether the parent needs
  215. * to update the child is dependent on what kind of slots the parent itself
  216. * received. This has to be refined at runtime, when the child's vnode
  217. * is being created (in `normalizeChildren`)
  218. */
  219. FORWARDED = 3
  220. }
  221. /**
  222. * Dev only
  223. */
  224. export declare const slotFlagsText: Record<SlotFlags, string>;
  225. export declare const isGloballyAllowed: (key: string) => boolean;
  226. /** @deprecated use `isGloballyAllowed` instead */
  227. export declare const isGloballyWhitelisted: (key: string) => boolean;
  228. export declare function generateCodeFrame(source: string, start?: number, end?: number): string;
  229. export type NormalizedStyle = Record<string, string | number>;
  230. export declare function normalizeStyle(value: unknown): NormalizedStyle | string | undefined;
  231. export declare function parseStringStyle(cssText: string): NormalizedStyle;
  232. export declare function stringifyStyle(styles: NormalizedStyle | string | undefined): string;
  233. export declare function normalizeClass(value: unknown): string;
  234. export declare function normalizeProps(props: Record<string, any> | null): Record<string, any> | null;
  235. /**
  236. * Compiler only.
  237. * Do NOT use in runtime code paths unless behind `__DEV__` flag.
  238. */
  239. export declare const isHTMLTag: (key: string) => boolean;
  240. /**
  241. * Compiler only.
  242. * Do NOT use in runtime code paths unless behind `__DEV__` flag.
  243. */
  244. export declare const isSVGTag: (key: string) => boolean;
  245. /**
  246. * Compiler only.
  247. * Do NOT use in runtime code paths unless behind `__DEV__` flag.
  248. */
  249. export declare const isMathMLTag: (key: string) => boolean;
  250. /**
  251. * Compiler only.
  252. * Do NOT use in runtime code paths unless behind `__DEV__` flag.
  253. */
  254. export declare const isVoidTag: (key: string) => boolean;
  255. export declare const isSpecialBooleanAttr: (key: string) => boolean;
  256. /**
  257. * The full list is needed during SSR to produce the correct initial markup.
  258. */
  259. export declare const isBooleanAttr: (key: string) => boolean;
  260. /**
  261. * Boolean attributes should be included if the value is truthy or ''.
  262. * e.g. `<select multiple>` compiles to `{ multiple: '' }`
  263. */
  264. export declare function includeBooleanAttr(value: unknown): boolean;
  265. export declare function isSSRSafeAttrName(name: string): boolean;
  266. export declare const propsToAttrMap: Record<string, string | undefined>;
  267. /**
  268. * Known attributes, this is used for stringification of runtime static nodes
  269. * so that we don't stringify bindings that cannot be set from HTML.
  270. * Don't also forget to allow `data-*` and `aria-*`!
  271. * Generated from https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes
  272. */
  273. export declare const isKnownHtmlAttr: (key: string) => boolean;
  274. /**
  275. * Generated from https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute
  276. */
  277. export declare const isKnownSvgAttr: (key: string) => boolean;
  278. /**
  279. * Generated from https://developer.mozilla.org/en-US/docs/Web/MathML/Attribute
  280. */
  281. export declare const isKnownMathMLAttr: (key: string) => boolean;
  282. /**
  283. * Shared between server-renderer and runtime-core hydration logic
  284. */
  285. export declare function isRenderableAttrValue(value: unknown): boolean;
  286. export declare function escapeHtml(string: unknown): string;
  287. export declare function escapeHtmlComment(src: string): string;
  288. export declare const cssVarNameEscapeSymbolsRE: RegExp;
  289. export declare function getEscapedCssVarName(key: string, doubleEscape: boolean): string;
  290. export declare function looseEqual(a: any, b: any): boolean;
  291. export declare function looseIndexOf(arr: any[], val: any): number;
  292. /**
  293. * For converting {{ interpolation }} values to displayed strings.
  294. * @private
  295. */
  296. export declare const toDisplayString: (val: unknown) => string;
  297. export type Prettify<T> = {
  298. [K in keyof T]: T[K];
  299. } & {};
  300. export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
  301. export type LooseRequired<T> = {
  302. [P in keyof (T & Required<T>)]: T[P];
  303. };
  304. export type IfAny<T, Y, N> = 0 extends 1 & T ? Y : N;
  305. export type IsKeyValues<T, K = string> = IfAny<T, false, T extends object ? (keyof T extends K ? true : false) : false>;
  306. /**
  307. * Utility for extracting the parameters from a function overload (for typed emits)
  308. * https://github.com/microsoft/TypeScript/issues/32164#issuecomment-1146737709
  309. */
  310. export type OverloadParameters<T extends (...args: any[]) => any> = Parameters<OverloadUnion<T>>;
  311. type OverloadProps<TOverload> = Pick<TOverload, keyof TOverload>;
  312. type OverloadUnionRecursive<TOverload, TPartialOverload = unknown> = TOverload extends (...args: infer TArgs) => infer TReturn ? TPartialOverload extends TOverload ? never : OverloadUnionRecursive<TPartialOverload & TOverload, TPartialOverload & ((...args: TArgs) => TReturn) & OverloadProps<TOverload>> | ((...args: TArgs) => TReturn) : never;
  313. type OverloadUnion<TOverload extends (...args: any[]) => any> = Exclude<OverloadUnionRecursive<(() => never) & TOverload>, TOverload extends () => never ? never : () => never>;
  314. /**
  315. * Normalize CSS var value created by `v-bind` in `<style>` block
  316. * See https://github.com/vuejs/core/pull/12461#issuecomment-2495804664
  317. */
  318. export declare function normalizeCssVarValue(value: unknown): string;