shared.d.ts 10 KB

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