props.d.ts 3.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. import type { ExtractPropTypes, PropType } from '@vue/runtime-core';
  2. declare const wrapperKey: unique symbol;
  3. export declare type PropWrapper<T> = {
  4. [wrapperKey]: T;
  5. };
  6. export declare const propKey = "__elPropsReservedKey";
  7. declare type ResolveProp<T> = ExtractPropTypes<{
  8. key: {
  9. type: T;
  10. required: true;
  11. };
  12. }>['key'];
  13. declare type ResolvePropType<T> = ResolveProp<T> extends {
  14. type: infer V;
  15. } ? V : ResolveProp<T>;
  16. declare type ResolvePropTypeWithReadonly<T> = Readonly<T> extends Readonly<Array<infer A>> ? ResolvePropType<A[]> : ResolvePropType<T>;
  17. declare type IfUnknown<T, V> = [unknown] extends [T] ? V : T;
  18. declare type _BuildPropType<T, V, C> = (T extends PropWrapper<unknown> ? T[typeof wrapperKey] : [V] extends [never] ? ResolvePropTypeWithReadonly<T> : never) | V | C;
  19. export declare type BuildPropType<T, V, C> = _BuildPropType<IfUnknown<T, never>, IfUnknown<V, never>, IfUnknown<C, never>>;
  20. export declare type BuildPropOption<T, V, C, D extends BuildPropType<T, V, C>, R> = {
  21. type?: T;
  22. values?: readonly V[];
  23. required?: R;
  24. default?: R extends true ? never : D extends Record<string, unknown> | Array<any> ? () => D : (() => D) | D;
  25. validator?: ((val: any) => val is C) | ((val: any) => boolean);
  26. };
  27. declare type _BuildPropDefault<T, D> = [T] extends [
  28. Record<string, unknown> | Array<any> | Function
  29. ] ? D : D extends () => T ? ReturnType<D> : D;
  30. export declare type BuildPropDefault<T, D, R> = R extends true ? {
  31. readonly default?: undefined;
  32. } : {
  33. readonly default: Exclude<D, undefined> extends never ? undefined : Exclude<_BuildPropDefault<T, D>, undefined>;
  34. };
  35. export declare type BuildPropReturn<T, V, C, D, R> = {
  36. readonly type: PropType<BuildPropType<T, V, C>>;
  37. readonly required: IfUnknown<R, false>;
  38. readonly validator: ((val: unknown) => boolean) | undefined;
  39. [propKey]: true;
  40. } & BuildPropDefault<BuildPropType<T, V, C>, IfUnknown<D, never>, IfUnknown<R, false>>;
  41. /**
  42. * @description Build prop. It can better optimize prop types
  43. * @description 生成 prop,能更好地优化类型
  44. * @example
  45. // limited options
  46. // the type will be PropType<'light' | 'dark'>
  47. buildProp({
  48. type: String,
  49. values: ['light', 'dark'],
  50. } as const)
  51. * @example
  52. // limited options and other types
  53. // the type will be PropType<'small' | 'large' | number>
  54. buildProp({
  55. type: [String, Number],
  56. values: ['small', 'large'],
  57. validator: (val: unknown): val is number => typeof val === 'number',
  58. } as const)
  59. @link see more: https://github.com/element-plus/element-plus/pull/3341
  60. */
  61. export declare function buildProp<T = never, V = never, C = never, D extends BuildPropType<T, V, C> = never, R extends boolean = false>(option: BuildPropOption<T, V, C, D, R>, key?: string): BuildPropReturn<T, V, C, D, R>;
  62. declare type NativePropType = [
  63. ((...args: any) => any) | {
  64. new (...args: any): any;
  65. } | undefined | null
  66. ];
  67. export declare const buildProps: <O extends { [K in keyof O]: O[K] extends BuildPropReturn<any, any, any, any, any> ? O[K] : [O[K]] extends NativePropType ? O[K] : O[K] extends BuildPropOption<infer T, infer V, infer C, infer D, infer R> ? D extends _BuildPropType<IfUnknown<T, never>, IfUnknown<V, never>, IfUnknown<C, never>> ? BuildPropOption<T, V, C, D, R> : never : never; }>(props: O) => { [K_1 in keyof O]: O[K_1] extends {
  68. __elPropsReservedKey: boolean;
  69. } ? O[K_1] : [O[K_1]] extends NativePropType ? O[K_1] : O[K_1] extends BuildPropOption<infer T_1, infer V_1, infer C_1, infer _D, infer R_1> ? BuildPropReturn<T_1, V_1, C_1, O[K_1]["default"], R_1> : never; };
  70. export declare const definePropType: <T>(val: any) => PropWrapper<T>;
  71. export {};