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

Class: WriteOffPdfService

Stored PDF service. Uses BasePdfService to produce bytes then uploads and returns the Pdf entity.

Extends

• PdfService<WriteOffPdf, WriteOff, WriteOffRouteParams>

Constructors

Constructor

new WriteOffPdfService(fileLocation, manager?): WriteOffPdfService;

Parameters

Parameter	Type
fileLocation	string
manager?	EntityManager

Returns

WriteOffPdfService

Inherited from

PdfService.constructor

Properties

Property	Modifier	Type	Default value	Overrides	Inherited from
client	public	Client	undefined	-	PdfService.client
fileService	public	FileService	undefined	-	PdfService.fileService
manager	protected	EntityManager	undefined	-	PdfService.manager
pdfConstructor	public	typeof WriteOffPdf	WriteOffPdf	PdfService.pdfConstructor	-
routeConstructor	public	typeof WriteOffRouteParams	WriteOffRouteParams	PdfService.routeConstructor	-
stationary	public	string	'BAC'	-	PdfService.stationary

Methods

createPdfBuffer()

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

Core method that generates and returns the PDF bytes.

Parameters

Parameter	Type
entity	WriteOff

Returns

Promise<Buffer<ArrayBufferLike>>

Inherited from

PdfService.createPdfBuffer

---

createPdfWithEntity()

createPdfWithEntity(entity): Promise<WriteOffPdf>;

Persist the generated PDF and return the stored Pdf entity.

Parameters

Parameter	Type
entity	WriteOff

Returns

Promise<WriteOffPdf>

Inherited from

PdfService.createPdfWithEntity

---

createRaw()

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

Create raw output such as TEX or HTML bytes for preview or debugging.

Parameters

Parameter	Type
entity	WriteOff

Returns

Promise<Buffer<ArrayBufferLike>>

Inherited from

PdfService.createRaw

---

createTex()

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

Parameters

Parameter	Type
entity	WriteOff

Returns

Promise<Buffer<ArrayBufferLike>>

Deprecated

Use createRaw() instead

Inherited from

PdfService.createTex

---

generator()

generator(routeParams): Promise<FileResponse>;

Parameters

Parameter	Type
routeParams	WriteOffRouteParams

Returns

Promise<FileResponse>

Overrides

PdfService.generator

---

getFileSettings()

protected getFileSettings(fileType?): FileSettings;

Parameters

Parameter	Type	Default value
fileType	ReturnFileType	ReturnFileType.PDF

Returns

FileSettings

Inherited from

PdfService.getFileSettings

---

getParameters()

getParameters(entity): Promise<WriteOffParameters>;

Parameters

Parameter	Type
entity	WriteOff

Returns

Promise<WriteOffParameters>

Overrides

PdfService.getParameters

---

getRouteParams()

getRouteParams(entity, fileType?): Promise<WriteOffRouteParams>;

Parameters

Parameter	Type	Default value
entity	WriteOff	undefined
fileType	ReturnFileType	ReturnFileType.PDF

Returns

Promise<WriteOffRouteParams>

Inherited from

PdfService.getRouteParams

---

getClient()

static getClient(url): Client;

Parameters

Parameter	Type
url	string

Returns

Client

Inherited from

PdfService.getClient