packages/docs-shared/lib/ApiResult.ts

   1 import type { DocsApiErrorCode } from '@proton/shared/lib/api/docs'
   2
   3 export type DocsApiError = {
   4   code: DocsApiErrorCode
   5   message: string
   6 }
   7
   8 export class ApiResult<T> {
   9   constructor(
  10     private isSuccess: boolean,
  11     private error?: DocsApiError,
  12     private value?: T,
  13   ) {
  14     Object.freeze(this)
  15   }
  16
  17   isFailed(): boolean {
  18     return !this.isSuccess
  19   }
  20
  21   getValue(): T {
  22     if (!this.isSuccess) {
  23       throw new Error(`Cannot get value of an unsuccessful result: ${this.error}`)
  24     }
  25
  26     return this.value as T
  27   }
  28
  29   getError(): DocsApiError {
  30     if (this.isSuccess || this.error === undefined) {
  31       throw new Error('Cannot get an error of a successful result')
  32     }
  33
  34     return this.error
  35   }
  36
  37   getErrorMessage(): string {
  38     if (this.isSuccess || this.error === undefined) {
  39       throw new Error('Cannot get an error message of a successful result')
  40     }
  41
  42     return this.error.message
  43   }
  44
  45   static ok<U>(value?: U): ApiResult<U> {
  46     return new ApiResult<U>(true, undefined, value)
  47   }
  48
  49   static fail<U>(error: DocsApiError): ApiResult<U> {
  50     if (!error) {
  51       throw new Error('Attempting to create a failed result without an error')
  52     }
  53
  54     return new ApiResult<U>(false, error)
  55   }
  56 }