index.js 1.0 KB

123456789101112131415161718192021222324252627282930313233343536
  1. const {BatchError} = require('./batch');
  2. const {PageError} = require('./page');
  3. const {SequenceError} = require('./sequence');
  4. /**
  5. * @namespace errors
  6. * @description
  7. * Namespace for all custom error types supported by the library.
  8. *
  9. * In addition to the custom error type used by each method (regular error), they can also reject with
  10. * {@link external:TypeError TypeError} when receiving invalid input parameters.
  11. *
  12. * @property {function} BatchError
  13. * {@link errors.BatchError BatchError} class.
  14. *
  15. * Represents regular errors that can be reported by method {@link batch}.
  16. *
  17. * @property {function} PageError
  18. * {@link errors.PageError PageError} class.
  19. *
  20. * Represents regular errors that can be reported by method {@link page}.
  21. *
  22. * @property {function} SequenceError
  23. * {@link errors.SequenceError SequenceError} class.
  24. *
  25. * Represents regular errors that can be reported by method {@link sequence}.
  26. *
  27. */
  28. module.exports = {
  29. BatchError,
  30. PageError,
  31. SequenceError
  32. };
  33. Object.freeze(module.exports);