shared.d.ts 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145
  1. export declare const assign: {
  2. <T, U>(target: T, source: U): T & U;
  3. <T_1, U_1, V>(target: T_1, source1: U_1, source2: V): T_1 & U_1 & V;
  4. <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;
  5. (target: object, ...sources: any[]): any;
  6. };
  7. /**
  8. * Create a event emitter
  9. *
  10. * @returns An event emitter
  11. */
  12. export declare function createEmitter<Events extends Record<EventType, unknown>>(): Emittable<Events>;
  13. /**
  14. * Event emitter interface
  15. */
  16. export declare interface Emittable<Events extends Record<EventType, unknown> = {}> {
  17. /**
  18. * A map of event names of registered event handlers
  19. */
  20. events: EventHandlerMap<Events>;
  21. /**
  22. * Register an event handler with the event type
  23. *
  24. * @param event - An {@link EventType}
  25. * @param handler - An {@link EventHandler}, or a {@link WildcardEventHandler} if you are specified "*"
  26. */
  27. on<Key extends keyof Events>(event: Key | '*', handler: EventHandler<Events[keyof Events]> | WildcardEventHandler<Events>): void;
  28. /**
  29. * Unregister an event handler for the event type
  30. *
  31. * @param event - An {@link EventType}
  32. * @param handler - An {@link EventHandler}, or a {@link WildcardEventHandler} if you are specified "*"
  33. */
  34. off<Key extends keyof Events>(event: Key | '*', handler: EventHandler<Events[keyof Events]> | WildcardEventHandler<Events>): void;
  35. /**
  36. * Invoke all handlers with the event type
  37. *
  38. * @remarks
  39. * Note Manually firing "*" handlers should be not supported
  40. *
  41. * @param event - An {@link EventType}
  42. * @param payload - An event payload, optional
  43. */
  44. emit<Key extends keyof Events>(event: Key, payload?: Events[keyof Events]): void;
  45. }
  46. export declare function escapeHtml(rawText: string): string;
  47. /**
  48. * Event handler
  49. */
  50. export declare type EventHandler<T = unknown> = (payload?: T) => void;
  51. /**
  52. * Event handler list
  53. */
  54. export declare type EventHandlerList<T = unknown> = Array<EventHandler<T>>;
  55. /**
  56. * Event handler map
  57. */
  58. export declare type EventHandlerMap<Events extends Record<EventType, unknown>> = Map<keyof Events | '*', EventHandlerList<Events[keyof Events]> | WildcardEventHandlerList<Events>>;
  59. /**
  60. * Event type
  61. */
  62. export declare type EventType = string | symbol;
  63. export declare function format(message: string, ...args: any): string;
  64. export declare const friendlyJSONstringify: (json: unknown) => string;
  65. export declare function generateCodeFrame(source: string, start?: number, end?: number): string;
  66. export declare const generateFormatCacheKey: (locale: string, key: string, source: string) => string;
  67. export declare const getGlobalThis: () => any;
  68. export declare function hasOwn(obj: object | Array<any>, key: string): boolean;
  69. /**
  70. * Original Utilities
  71. * written by kazuya kawaguchi
  72. */
  73. export declare const inBrowser: boolean;
  74. /**
  75. * Useful Utilities By Evan you
  76. * Modified by kazuya kawaguchi
  77. * MIT License
  78. * https://github.com/vuejs/vue-next/blob/master/packages/shared/src/index.ts
  79. * https://github.com/vuejs/vue-next/blob/master/packages/shared/src/codeframe.ts
  80. */
  81. export declare const isArray: (arg: any) => arg is any[];
  82. export declare const isBoolean: (val: unknown) => val is boolean;
  83. export declare const isDate: (val: unknown) => val is Date;
  84. export declare const isEmptyObject: (val: unknown) => val is boolean;
  85. export declare const isFunction: (val: unknown) => val is Function;
  86. export declare const isNumber: (val: unknown) => val is number;
  87. export declare const isObject: (val: unknown) => val is Record<any, any>;
  88. export declare const isPlainObject: (val: unknown) => val is object;
  89. export declare const isPromise: <T = any>(val: unknown) => val is Promise<T>;
  90. export declare const isRegExp: (val: unknown) => val is RegExp;
  91. export declare const isString: (val: unknown) => val is string;
  92. export declare const isSymbol: (val: unknown) => val is symbol;
  93. export declare const makeSymbol: (name: string) => symbol | string;
  94. export declare let mark: (tag: string) => void | undefined;
  95. export declare let measure: (name: string, startTag: string, endTag: string) => void | undefined;
  96. export declare const objectToString: () => string;
  97. export declare const toDisplayString: (val: unknown) => string;
  98. export declare const toTypeString: (value: unknown) => string;
  99. export declare function warn(msg: string, err?: Error): void;
  100. /**
  101. * Wildcard event handler
  102. */
  103. export declare type WildcardEventHandler<T = Record<string, unknown>> = (event: keyof T, payload?: T[keyof T]) => void;
  104. /**
  105. * Wildcard event handler list
  106. */
  107. export declare type WildcardEventHandlerList<T = Record<string, unknown>> = Array<WildcardEventHandler<T>>;
  108. export { }