shared.d.ts 4.9 KB

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