toast.d.ts 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. import { OnChangeCallback } from './eventManager';
  2. import { ToastContent, ToastOptions, Id, UpdateOptions, ClearWaitingQueueParams, TypeOptions } from '../types';
  3. declare function toast<TData = unknown>(content: ToastContent<TData>, options?: ToastOptions): Id;
  4. declare namespace toast {
  5. var loading: <TData = unknown>(content: ToastContent<TData>, options?: ToastOptions<{}> | undefined) => Id;
  6. var promise: typeof handlePromise;
  7. var success: <TData = unknown>(content: ToastContent<TData>, options?: ToastOptions<{}> | undefined) => Id;
  8. var info: <TData = unknown>(content: ToastContent<TData>, options?: ToastOptions<{}> | undefined) => Id;
  9. var error: <TData = unknown>(content: ToastContent<TData>, options?: ToastOptions<{}> | undefined) => Id;
  10. var warning: <TData = unknown>(content: ToastContent<TData>, options?: ToastOptions<{}> | undefined) => Id;
  11. var warn: <TData = unknown>(content: ToastContent<TData>, options?: ToastOptions<{}> | undefined) => Id;
  12. var dark: (content: ToastContent, options?: ToastOptions<{}> | undefined) => Id;
  13. var dismiss: (id?: Id | undefined) => void;
  14. var clearWaitingQueue: (params?: ClearWaitingQueueParams) => void;
  15. var isActive: (id: Id) => boolean;
  16. var update: <TData = unknown>(toastId: Id, options?: UpdateOptions<TData>) => void;
  17. var done: (id: Id) => void;
  18. var onChange: (callback: OnChangeCallback) => () => void;
  19. var POSITION: {
  20. TOP_LEFT: import("../types").ToastPosition;
  21. TOP_RIGHT: import("../types").ToastPosition;
  22. TOP_CENTER: import("../types").ToastPosition;
  23. BOTTOM_LEFT: import("../types").ToastPosition;
  24. BOTTOM_RIGHT: import("../types").ToastPosition;
  25. BOTTOM_CENTER: import("../types").ToastPosition;
  26. };
  27. var TYPE: {
  28. INFO: TypeOptions;
  29. SUCCESS: TypeOptions;
  30. WARNING: TypeOptions;
  31. ERROR: TypeOptions;
  32. DEFAULT: TypeOptions;
  33. };
  34. }
  35. export interface ToastPromiseParams<TData = unknown, TError = unknown, TPending = unknown> {
  36. pending?: string | UpdateOptions<TPending>;
  37. success?: string | UpdateOptions<TData>;
  38. error?: string | UpdateOptions<TError>;
  39. }
  40. declare function handlePromise<TData = unknown, TError = unknown, TPending = unknown>(promise: Promise<TData> | (() => Promise<TData>), { pending, error, success }: ToastPromiseParams<TData, TError, TPending>, options?: ToastOptions): Promise<TData>;
  41. export { toast };