SudoSOS Back-end API / reports / FineReport

Class: FineReport

Extends

• UnstoredPdfAbleClass<typeof IFineReport, this> & IFineReport<this>

Constructors

Constructor

new FineReport(init?): FineReport;

Parameters

Parameter	Type
init?	Partial<IFineReport>

Returns

FineReport

Inherited from

UnstoredPdfAble(IFineReport).constructor

Properties

Property	Type	Description	Overrides	Inherited from
count	number	-	-	UnstoredPdfAble(IFineReport).count
fromDate	Date	-	-	UnstoredPdfAble(IFineReport).fromDate
handedOut	Dinero	-	-	UnstoredPdfAble(IFineReport).handedOut
pdfService	FineReportPdfService	The service that creates the Pdf buffer. Can be either a LaTeX-based service (UnstoredPdfService) or HTML-based service (HtmlUnstoredPdfService).	UnstoredPdfAble(IFineReport).pdfService	-
toDate	Date	-	-	UnstoredPdfAble(IFineReport).toDate
waivedAmount	Dinero	-	-	UnstoredPdfAble(IFineReport).waivedAmount
waivedCount	number	-	-	UnstoredPdfAble(IFineReport).waivedCount

Methods

createPdf()

createPdf(): Promise<Buffer<ArrayBufferLike>>;

Create the Pdf buffer. This method generates the PDF and returns it as a Buffer.

Returns

Promise<Buffer<ArrayBufferLike>>

Inherited from

UnstoredPdfAble(IFineReport).createPdf

---

createRaw()

createRaw(): Promise<Buffer<ArrayBufferLike>>;

Returns

Promise<Buffer<ArrayBufferLike>>

Inherited from

UnstoredPdfAble(IFineReport).createRaw

---

createTex()

createTex(): Promise<Buffer<ArrayBufferLike>>;

Returns

Promise<Buffer<ArrayBufferLike>>

Deprecated

Use createRaw() instead

Inherited from

UnstoredPdfAble(IFineReport).createTex

---

getPdfParamHash()

getPdfParamHash(): Promise<string>;

Returns

Promise<string>

Inherited from

UnstoredPdfAble(IFineReport).getPdfParamHash

---

toResponse()

toResponse(): FineReportResponse;

Returns

FineReportResponse