SudoSOS Back-end API / internal/pdf/write-off-pdf-service / WriteOffPdfService

Class: WriteOffPdfService

A PdfService whose output is a record we send to people. Once stored, the PDF is frozen (#141): it is returned as-is, and only re-rendered when force is set or its hash was cleared to mark it stale.

Extends

• StoredPdfService<WriteOff, WriteOffPdf, IWriteOffPdf>

Constructors

Constructor

new WriteOffPdfService(manager?): WriteOffPdfService;

Parameters

Parameter	Type
manager?	EntityManager

Returns

WriteOffPdfService

Inherited from

StoredPdfService.constructor

Properties

Property	Modifier	Type	Default value	Overrides	Inherited from
location	readonly	"./data/write_offs"	WRITE_OFF_PDF_LOCATION	StoredPdfService.location	-
manager	protected	EntityManager	undefined	-	StoredPdfService.manager
pdfConstructor	readonly	typeof WriteOffPdf	WriteOffPdf	StoredPdfService.pdfConstructor	-
render	public	(options) => string	createWriteOffPdf	StoredPdfService.render	-

Methods

compile()

protected compile(params): Promise<Buffer<ArrayBufferLike>>;

Parameters

Parameter	Type
params	IWriteOffPdf

Returns

Promise<Buffer<ArrayBufferLike>>

Inherited from

StoredPdfService.compile

---

configureLogger()

protected configureLogger(logger): void;

Parameters

Parameter	Type
logger	Logger

Returns

void

Inherited from

StoredPdfService.configureLogger

---

getOrCreate()

getOrCreate(entity, force?): Promise<WriteOffPdf>;

Parameters

Parameter	Type	Default value
entity	WriteOff	undefined
force	boolean	false

Returns

Promise<WriteOffPdf>

Inherited from

StoredPdfService.getOrCreate

---

getOwner()

getOwner(entity): User;

Parameters

Parameter	Type
entity	WriteOff

Returns

User

Overrides

StoredPdfService.getOwner

---

getParameters()

getParameters(entity): Promise<IWriteOffPdf>;

Parameters

Parameter	Type
entity	WriteOff

Returns

Promise<IWriteOffPdf>

Overrides

StoredPdfService.getParameters

---

html()

html(entity): Promise<Buffer<ArrayBufferLike>>;

Parameters

Parameter	Type
entity	WriteOff

Returns

Promise<Buffer<ArrayBufferLike>>

Inherited from

StoredPdfService.html

---

output()

output(entity, fileType): Promise<Buffer<ArrayBufferLike>>;

Parameters

Parameter	Type
entity	WriteOff
fileType	ReturnFileType

Returns

Promise<Buffer<ArrayBufferLike>>

Inherited from

StoredPdfService.output

---

pdf()

pdf(entity): Promise<Buffer<ArrayBufferLike>>;

Parameters

Parameter	Type
entity	WriteOff

Returns

Promise<Buffer<ArrayBufferLike>>

Inherited from

StoredPdfService.pdf