Class PdfRendererClient

constructor

• new PdfRendererClient(
      __namedParameters: { lambda: () => LambdaClient; s3: S3Client },
  ): PdfRendererClient

  Parameters

  • __namedParameters: { lambda: () => LambdaClient; s3: S3Client }

    • lambda: () => LambdaClient

      An opener read at each render.

    • s3: S3Client

  Returns PdfRendererClient

Staticinstance

render

• render(
      sections: PdfSection<
          | "account-statement"
          | "bank-letter"
          | "deposit-instruction-ach"
          | "deposit-instruction-fedwire"
          | "deposit-instruction-rtp"
          | "deposit-instruction-swift"
          | "routefusion-kyc",
      >[],
      opts?: { draft?: PdfDraft },
  ): Promise<
      | { ok: true; value: ReadableStream }
      | { error: PdfRenderFailed; ok: false },
  >

  Parameters

  • sections: PdfSection<
        | "account-statement"
        | "bank-letter"
        | "deposit-instruction-ach"
        | "deposit-instruction-fedwire"
        | "deposit-instruction-rtp"
        | "deposit-instruction-swift"
        | "routefusion-kyc",
    >[]
  • Optionalopts: { draft?: PdfDraft }

  Returns Promise<
      | { ok: true; value: ReadableStream }
      | { error: PdfRenderFailed; ok: false },
  >

renderUnchecked

• renderUnchecked(
      sections: { data: unknown; template: string }[],
      opts?: { draft?: PdfDraft },
  ): Promise<
      | { ok: true; value: ReadableStream }
      | { error: PdfRenderFailed; ok: false },
  >

  Any key, data unchecked: for operator-chosen keys and the letterhead library.

  Parameters

  • sections: { data: unknown; template: string }[]
  • Optionalopts: { draft?: PdfDraft }

  Returns Promise<
      | { ok: true; value: ReadableStream }
      | { error: PdfRenderFailed; ok: false },
  >