vevet/src/base/Module/types.ts

Vevet is a JavaScript library for creative development that simplifies crafting rich interactions like split text animations, carousels, marquees, preloading, and more.

import { ICallbacksMap, TCallbacksAction } from '../Callbacks';

export interface IModuleStaticProps {
  __staticProp?: true;
}

export interface IModuleMutableProps {
  __mutableProp?: true;
}

export interface IModuleCallbacksMap<
  TM = Record<string, any>,
> extends ICallbacksMap {
  /**
   * Triggered when the module is destroyed.
   */
  destroy: undefined;

  /**
   * Triggered when the module's properties are updated.
   * Receives the diff (changed keys and new values) as the first argument.
   */
  props: Partial<TM>;
}

export type TModuleOnCallbacksProps<T, Ctx> = Partial<{
  [K in keyof T as `on${Capitalize<string & K>}`]: TCallbacksAction<T[K], Ctx>;
}>;