PreventLeave hook documentation

  • Type Parameters

    • Data = any

      The data type

    • ID = string

      The ID type

    Parameters

    • Optionalparams: IPreventLeaveParams<Data, ID>

      The optional parameters

      Interface for the parameters of the IPreventLeaveParams class.

      • OptionalchangeSubject?: TSubject<Data>
      • OptionalcheckDirty?: (prevData: Data, currentData: Data) => boolean
      • OptionalcheckUpdate?: (id: ID, data: Data) => boolean
      • Optionaldata?: null | Data
      • Optionalfallback?: (e: Error) => void
      • Optionalhistory?: any
      • OptionalonBlock?: () => void | () => void
      • OptionalonChange?: (Data: Data, initial: boolean) => void
      • OptionalonLoadEnd?: (isOk: boolean) => void
      • OptionalonLoadStart?: () => void
      • OptionalonSave?: (data: Data) => boolean | Promise<boolean>
      • OptionalonUpdate?: (id: ID, data: Data) => void
      • Optionalreadonly?: boolean
      • OptionalshouldAutoSave?: () => boolean
      • OptionalupdateSubject?: TSubject<[ID, Data]>
      • OptionalwaitForChangesDelay?: number

    Returns IPreventLeaveReturn<Data>

    • The PreventLeave hook return object