element-plus/packages/utils/types.ts

A Component Library for Vue 3

import type { CSSProperties, Plugin } from 'vue'

type OptionalKeys<T extends Record<string, unknown>> = {
  [K in keyof T]: T extends Record<K, T[K]> ? never : K
}[keyof T]

type RequiredKeys<T extends Record<string, unknown>> = Exclude<
  keyof T,
  OptionalKeys<T>
>

type MonoArgEmitter<T, Keys extends keyof T> = <K extends Keys>(
  evt: K,
  arg?: T[K]
) => void

type BiArgEmitter<T, Keys extends keyof T> = <K extends Keys>(
  evt: K,
  arg: T[K]
) => void

export type EventEmitter<T extends Record<string, unknown>> = MonoArgEmitter<
  T,
  OptionalKeys<T>
> &
  BiArgEmitter<T, RequiredKeys<T>>

export type AnyFunction<T> = (...args: any[]) => T

export type PartialReturnType<T extends (...args: unknown[]) => unknown> =
  Partial<ReturnType<T>>

export type SFCWithInstall<T> = T & Plugin

export type RefElement = HTMLElement | null

export type Nullable<T> = T | null

export type CustomizedHTMLElement<T> = HTMLElement & T

export type Indexable<T> = {
  [key: string]: T
}

export type Hash<T> = Indexable<T>

export type TimeoutHandle = ReturnType<typeof global.setTimeout>

export type ComponentSize = 'large' | 'medium' | 'small' | 'mini'

export type StyleValue = string | CSSProperties | Array<StyleValue>

export type Mutable<T> = { -readonly [P in keyof T]: T[P] }