Class MurError

Readonlyname

Readonlycode

Readonlydetails

StaticisMurError

• isMurError(
      value: unknown,
  ): value is
      | MurError & {
          code: "QrEncode";
          details: Readonly<MurErrorDetailsByCode[C]>;
      }
      | MurError & {
          code: "ImageEncode";
          details: Readonly<MurErrorDetailsByCode[C]>;
      }
      | MurError & {
          code: "SvgRender";
          details: Readonly<MurErrorDetailsByCode[C]>;
      }
      | MurError & {
          code: "InvalidColor";
          details: Readonly<MurErrorDetailsByCode[C]>;
      }
      | MurError & {
          code: "InvalidParameter";
          details: Readonly<MurErrorDetailsByCode[C]>;
      }
      | MurError & {
          code: "GifEncode";
          details: Readonly<MurErrorDetailsByCode[C]>;
      }
      | MurError & {
          code: "FfmpegNotFound";
          details: Readonly<MurErrorDetailsByCode[C]>;
      }
      | MurError & {
          code: "FfmpegFailed";
          details: Readonly<MurErrorDetailsByCode[C]>;
      }
      | MurError & {
          code: "QrCodeTooDense";
          details: Readonly<MurErrorDetailsByCode[C]>;
      }
      | MurError & {
          code: "InsufficientFrames";
          details: Readonly<MurErrorDetailsByCode[C]>;
      }
      | MurError & { code: "Io"; details: Readonly<MurErrorDetailsByCode[C]> }
      | MurError & { code: "Ur"; details: Readonly<MurErrorDetailsByCode[C]> }

  Type guard: is value a MurError (from any copy of this package)? Narrows to MurErrorTyped.

  Parameters

  • value: unknown

  Returns value is
      | MurError & {
          code: "QrEncode";
          details: Readonly<MurErrorDetailsByCode[C]>;
      }
      | MurError & {
          code: "ImageEncode";
          details: Readonly<MurErrorDetailsByCode[C]>;
      }
      | MurError & {
          code: "SvgRender";
          details: Readonly<MurErrorDetailsByCode[C]>;
      }
      | MurError & {
          code: "InvalidColor";
          details: Readonly<MurErrorDetailsByCode[C]>;
      }
      | MurError & {
          code: "InvalidParameter";
          details: Readonly<MurErrorDetailsByCode[C]>;
      }
      | MurError & {
          code: "GifEncode";
          details: Readonly<MurErrorDetailsByCode[C]>;
      }
      | MurError & {
          code: "FfmpegNotFound";
          details: Readonly<MurErrorDetailsByCode[C]>;
      }
      | MurError & {
          code: "FfmpegFailed";
          details: Readonly<MurErrorDetailsByCode[C]>;
      }
      | MurError & {
          code: "QrCodeTooDense";
          details: Readonly<MurErrorDetailsByCode[C]>;
      }
      | MurError & {
          code: "InsufficientFrames";
          details: Readonly<MurErrorDetailsByCode[C]>;
      }
      | MurError & { code: "Io"; details: Readonly<MurErrorDetailsByCode[C]> }
      | MurError & { code: "Ur"; details: Readonly<MurErrorDetailsByCode[C]> }

is

• is<C extends MurErrorCode>(code: C): this is MurErrorTyped<C>

  Whether this error has code; narrows details to that code's fields.

  Type Parameters

  • C extends MurErrorCode

  Parameters

  • code: C

  Returns this is MurErrorTyped<C>

StaticqrEncode

• qrEncode(
      message: string,
      cause?: unknown,
  ): MurError & {
      code: "QrEncode";
      details: Readonly<MurErrorDetailsByCode[C]>;
  }

  QrEncode: the QR encoder rejected the message (too long for version 40 at this level).

  Parameters

  • message: string
  • Optionalcause: unknown

  Returns MurError & { code: "QrEncode"; details: Readonly<MurErrorDetailsByCode[C]> }

StaticimageEncode

• imageEncode(
      message: string,
      cause?: unknown,
  ): MurError & {
      code: "ImageEncode";
      details: Readonly<MurErrorDetailsByCode[C]>;
  }

  ImageEncode: PNG/JPEG encoding or logo decoding failed.

  Parameters

  • message: string
  • Optionalcause: unknown

  Returns MurError & { code: "ImageEncode"; details: Readonly<MurErrorDetailsByCode[C]> }

StaticsvgRender

• svgRender(
      message: string,
      cause?: unknown,
  ): MurError & {
      code: "SvgRender";
      details: Readonly<MurErrorDetailsByCode[C]>;
  }

  SvgRender: the SVG could not be parsed or rasterised.

  Parameters

  • message: string
  • Optionalcause: unknown

  Returns MurError & { code: "SvgRender"; details: Readonly<MurErrorDetailsByCode[C]> }

StaticinvalidColor

• invalidColor(
      message: string,
  ): MurError & {
      code: "InvalidColor";
      details: Readonly<MurErrorDetailsByCode[C]>;
  }

  InvalidColor: a hex string or channel value is not a colour.

  Parameters

  • message: string

  Returns MurError & { code: "InvalidColor"; details: Readonly<MurErrorDetailsByCode[C]> }

StaticinvalidParameter

• invalidParameter(
      message: string,
  ): MurError & {
      code: "InvalidParameter";
      details: Readonly<MurErrorDetailsByCode[C]>;
  }

  InvalidParameter: an argument is outside its domain.

  Parameters

  • message: string

  Returns MurError & {
      code: "InvalidParameter";
      details: Readonly<MurErrorDetailsByCode[C]>;
  }

StaticgifEncode

• gifEncode(
      message: string,
      cause?: unknown,
  ): MurError & {
      code: "GifEncode";
      details: Readonly<MurErrorDetailsByCode[C]>;
  }

  GifEncode: the GIF encoder failed.

  Parameters

  • message: string
  • Optionalcause: unknown

  Returns MurError & { code: "GifEncode"; details: Readonly<MurErrorDetailsByCode[C]> }

StaticffmpegNotFound

• ffmpegNotFound(): MurError & {
      code: "FfmpegNotFound";
      details: Readonly<MurErrorDetailsByCode[C]>;
  }

  FfmpegNotFound: no ffmpeg on PATH.

  Returns MurError & {
      code: "FfmpegNotFound";
      details: Readonly<MurErrorDetailsByCode[C]>;
  }

StaticffmpegFailed

• ffmpegFailed(
      message: string,
      options?: { cause?: unknown; stderr?: string },
  ): MurError & {
      code: "FfmpegFailed";
      details: Readonly<MurErrorDetailsByCode[C]>;
  }

  FfmpegFailed: ffmpeg could not be started or exited with a failure status.

  Parameters

  • message: string
  • options: { cause?: unknown; stderr?: string } = {}

  Returns MurError & { code: "FfmpegFailed"; details: Readonly<MurErrorDetailsByCode[C]> }

StaticqrCodeTooDense

• qrCodeTooDense(
      moduleCount: number,
      maxModules: number,
  ): MurError & {
      code: "QrCodeTooDense";
      details: Readonly<MurErrorDetailsByCode[C]>;
  }

  QrCodeTooDense: the symbol has more modules than the limit allows.

  Parameters

  • moduleCount: number
  • maxModules: number

  Returns MurError & {
      code: "QrCodeTooDense";
      details: Readonly<MurErrorDetailsByCode[C]>;
  }

StaticinsufficientFrames

• insufficientFrames(
      requested: number,
      fragments: number,
  ): MurError & {
      code: "InsufficientFrames";
      details: Readonly<MurErrorDetailsByCode[C]>;
  }

  InsufficientFrames: fewer frames than the message has fragments.

  Parameters

  • requested: number
  • fragments: number

  Returns MurError & {
      code: "InsufficientFrames";
      details: Readonly<MurErrorDetailsByCode[C]>;
  }

Staticio

• io(
      message: string,
      options?: { cause?: unknown; path?: string },
  ): MurError & { code: "Io"; details: Readonly<MurErrorDetailsByCode[C]> }

  Io: a file could not be read, written or created.

  Parameters

  • message: string
  • options: { cause?: unknown; path?: string } = {}

  Returns MurError & { code: "Io"; details: Readonly<MurErrorDetailsByCode[C]> }

Staticur

• ur(
      message: string,
      cause?: unknown,
  ): MurError & { code: "Ur"; details: Readonly<MurErrorDetailsByCode[C]> }

  Ur: uniform-resources rejected the UR or the fragment length.

  Parameters

  • message: string
  • Optionalcause: unknown

  Returns MurError & { code: "Ur"; details: Readonly<MurErrorDetailsByCode[C]> }