shared.d.ts 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308
  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, expectsLowerCase?: boolean): (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) => boolean;
  20. export declare const extend: {
  21. <T extends {}, U>(target: T, source: U): T & U;
  22. <T_1 extends {}, U_1, V>(target: T_1, source1: U_1, source2: V): T_1 & U_1 & V;
  23. <T_2 extends {}, U_2, V_1, W>(target: T_2, source1: U_2, source2: V_1, source3: W): T_2 & U_2 & V_1 & W;
  24. (target: object, ...sources: any[]): any;
  25. };
  26. export declare const remove: <T>(arr: T[], el: T) => void;
  27. export declare const hasOwn: (val: object, key: string | symbol) => key is never;
  28. export declare const isArray: (arg: any) => arg is any[];
  29. export declare const isMap: (val: unknown) => val is Map<any, any>;
  30. export declare const isSet: (val: unknown) => val is Set<any>;
  31. export declare const isDate: (val: unknown) => val is Date;
  32. export declare const isRegExp: (val: unknown) => val is RegExp;
  33. export declare const isFunction: (val: unknown) => val is Function;
  34. export declare const isString: (val: unknown) => val is string;
  35. export declare const isSymbol: (val: unknown) => val is symbol;
  36. export declare const isObject: (val: unknown) => val is Record<any, any>;
  37. export declare const isPromise: <T = any>(val: unknown) => val is Promise<T>;
  38. export declare const objectToString: () => string;
  39. export declare const toTypeString: (value: unknown) => string;
  40. export declare const toRawType: (value: unknown) => string;
  41. export declare const isPlainObject: (val: unknown) => val is object;
  42. export declare const isIntegerKey: (key: unknown) => boolean;
  43. export declare const isReservedProp: (key: string) => boolean;
  44. export declare const isBuiltInDirective: (key: string) => boolean;
  45. /**
  46. * @private
  47. */
  48. export declare const camelize: (str: string) => string;
  49. /**
  50. * @private
  51. */
  52. export declare const hyphenate: (str: string) => string;
  53. /**
  54. * @private
  55. */
  56. export declare const capitalize: (str: string) => string;
  57. /**
  58. * @private
  59. */
  60. export declare const toHandlerKey: (str: string) => string;
  61. export declare const hasChanged: (value: any, oldValue: any) => boolean;
  62. export declare const invokeArrayFns: (fns: Function[], arg?: any) => void;
  63. export declare const def: (obj: object, key: string | symbol, value: any) => void;
  64. /**
  65. * "123-foo" will be parsed to 123
  66. * This is used for the .number modifier in v-model
  67. */
  68. export declare const looseToNumber: (val: any) => any;
  69. /**
  70. * Only conerces number-like strings
  71. * "123-foo" will be returned as-is
  72. */
  73. export declare const toNumber: (val: any) => any;
  74. export declare const getGlobalThis: () => any;
  75. export declare function genPropsAccessExp(name: string): string;
  76. /**
  77. * Patch flags are optimization hints generated by the compiler.
  78. * when a block with dynamicChildren is encountered during diff, the algorithm
  79. * enters "optimized mode". In this mode, we know that the vdom is produced by
  80. * a render function generated by the compiler, so the algorithm only needs to
  81. * handle updates explicitly marked by these patch flags.
  82. *
  83. * Patch flags can be combined using the | bitwise operator and can be checked
  84. * using the & operator, e.g.
  85. *
  86. * ```js
  87. * const flag = TEXT | CLASS
  88. * if (flag & TEXT) { ... }
  89. * ```
  90. *
  91. * Check the `patchElement` function in '../../runtime-core/src/renderer.ts' to see how the
  92. * flags are handled during diff.
  93. */
  94. export declare const enum PatchFlags {
  95. /**
  96. * Indicates an element with dynamic textContent (children fast path)
  97. */
  98. TEXT = 1,
  99. /**
  100. * Indicates an element with dynamic class binding.
  101. */
  102. CLASS = 2,
  103. /**
  104. * Indicates an element with dynamic style
  105. * The compiler pre-compiles static string styles into static objects
  106. * + detects and hoists inline static objects
  107. * e.g. `style="color: red"` and `:style="{ color: 'red' }"` both get hoisted
  108. * as:
  109. * ```js
  110. * const style = { color: 'red' }
  111. * render() { return e('div', { style }) }
  112. * ```
  113. */
  114. STYLE = 4,
  115. /**
  116. * Indicates an element that has non-class/style dynamic props.
  117. * Can also be on a component that has any dynamic props (includes
  118. * class/style). when this flag is present, the vnode also has a dynamicProps
  119. * array that contains the keys of the props that may change so the runtime
  120. * can diff them faster (without having to worry about removed props)
  121. */
  122. PROPS = 8,
  123. /**
  124. * Indicates an element with props with dynamic keys. When keys change, a full
  125. * diff is always needed to remove the old key. This flag is mutually
  126. * exclusive with CLASS, STYLE and PROPS.
  127. */
  128. FULL_PROPS = 16,
  129. /**
  130. * Indicates an element with event listeners (which need to be attached
  131. * during hydration)
  132. */
  133. HYDRATE_EVENTS = 32,
  134. /**
  135. * Indicates a fragment whose children order doesn't change.
  136. */
  137. STABLE_FRAGMENT = 64,
  138. /**
  139. * Indicates a fragment with keyed or partially keyed children
  140. */
  141. KEYED_FRAGMENT = 128,
  142. /**
  143. * Indicates a fragment with unkeyed children.
  144. */
  145. UNKEYED_FRAGMENT = 256,
  146. /**
  147. * Indicates an element that only needs non-props patching, e.g. ref or
  148. * directives (onVnodeXXX hooks). since every patched vnode checks for refs
  149. * and onVnodeXXX hooks, it simply marks the vnode so that a parent block
  150. * will track it.
  151. */
  152. NEED_PATCH = 512,
  153. /**
  154. * Indicates a component with dynamic slots (e.g. slot that references a v-for
  155. * iterated value, or dynamic slot names).
  156. * Components with this flag are always force updated.
  157. */
  158. DYNAMIC_SLOTS = 1024,
  159. /**
  160. * Indicates a fragment that was created only because the user has placed
  161. * comments at the root level of a template. This is a dev-only flag since
  162. * comments are stripped in production.
  163. */
  164. DEV_ROOT_FRAGMENT = 2048,
  165. /**
  166. * SPECIAL FLAGS -------------------------------------------------------------
  167. * Special flags are negative integers. They are never matched against using
  168. * bitwise operators (bitwise matching should only happen in branches where
  169. * patchFlag > 0), and are mutually exclusive. When checking for a special
  170. * flag, simply check patchFlag === FLAG.
  171. */
  172. /**
  173. * Indicates a hoisted static vnode. This is a hint for hydration to skip
  174. * the entire sub tree since static content never needs to be updated.
  175. */
  176. HOISTED = -1,
  177. /**
  178. * A special flag that indicates that the diffing algorithm should bail out
  179. * of optimized mode. For example, on block fragments created by renderSlot()
  180. * when encountering non-compiler generated slots (i.e. manually written
  181. * render functions, which should always be fully diffed)
  182. * OR manually cloneVNodes
  183. */
  184. BAIL = -2
  185. }
  186. /**
  187. * dev only flag -> name mapping
  188. */
  189. export declare const PatchFlagNames: Record<PatchFlags, string>;
  190. export declare const enum ShapeFlags {
  191. ELEMENT = 1,
  192. FUNCTIONAL_COMPONENT = 2,
  193. STATEFUL_COMPONENT = 4,
  194. TEXT_CHILDREN = 8,
  195. ARRAY_CHILDREN = 16,
  196. SLOTS_CHILDREN = 32,
  197. TELEPORT = 64,
  198. SUSPENSE = 128,
  199. COMPONENT_SHOULD_KEEP_ALIVE = 256,
  200. COMPONENT_KEPT_ALIVE = 512,
  201. COMPONENT = 6
  202. }
  203. export declare const enum SlotFlags {
  204. /**
  205. * Stable slots that only reference slot props or context state. The slot
  206. * can fully capture its own dependencies so when passed down the parent won't
  207. * need to force the child to update.
  208. */
  209. STABLE = 1,
  210. /**
  211. * Slots that reference scope variables (v-for or an outer slot prop), or
  212. * has conditional structure (v-if, v-for). The parent will need to force
  213. * the child to update because the slot does not fully capture its dependencies.
  214. */
  215. DYNAMIC = 2,
  216. /**
  217. * `<slot/>` being forwarded into a child component. Whether the parent needs
  218. * to update the child is dependent on what kind of slots the parent itself
  219. * received. This has to be refined at runtime, when the child's vnode
  220. * is being created (in `normalizeChildren`)
  221. */
  222. FORWARDED = 3
  223. }
  224. /**
  225. * Dev only
  226. */
  227. export declare const slotFlagsText: {
  228. 1: string;
  229. 2: string;
  230. 3: string;
  231. };
  232. export declare const isGloballyWhitelisted: (key: string) => boolean;
  233. export declare function generateCodeFrame(source: string, start?: number, end?: number): string;
  234. export type NormalizedStyle = Record<string, string | number>;
  235. export declare function normalizeStyle(value: unknown): NormalizedStyle | string | undefined;
  236. export declare function parseStringStyle(cssText: string): NormalizedStyle;
  237. export declare function stringifyStyle(styles: NormalizedStyle | string | undefined): string;
  238. export declare function normalizeClass(value: unknown): string;
  239. export declare function normalizeProps(props: Record<string, any> | null): Record<string, any> | null;
  240. /**
  241. * Compiler only.
  242. * Do NOT use in runtime code paths unless behind `__DEV__` flag.
  243. */
  244. export declare const isHTMLTag: (key: string) => boolean;
  245. /**
  246. * Compiler only.
  247. * Do NOT use in runtime code paths unless behind `__DEV__` flag.
  248. */
  249. export declare const isSVGTag: (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. export declare function escapeHtml(string: unknown): string;
  279. export declare function escapeHtmlComment(src: string): string;
  280. export declare function looseEqual(a: any, b: any): boolean;
  281. export declare function looseIndexOf(arr: any[], val: any): number;
  282. /**
  283. * For converting {{ interpolation }} values to displayed strings.
  284. * @private
  285. */
  286. export declare const toDisplayString: (val: unknown) => string;
  287. export type Prettify<T> = {
  288. [K in keyof T]: T[K];
  289. } & {};
  290. export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
  291. export type LooseRequired<T> = {
  292. [P in keyof (T & Required<T>)]: T[P];
  293. };
  294. export type IfAny<T, Y, N> = 0 extends 1 & T ? Y : N;