SudoSOS Back-end API / internal/pdf / BasePdfService

Abstract Class: BasePdfService<T, R>

Base PDF service that always provides bytes. Concrete services that store a Pdf entity should implement IStoredPdfService.

Extends

• WithManager

Extended by

• PdfService
• UnstoredPdfService

Type Parameters

Type Parameter
T
R extends RouteParams

Implements

• IPdfServiceBase<T>

Constructors

Constructor

new BasePdfService<T, R>(manager?): BasePdfService<T, R>;

Parameters

Parameter	Type
manager?	EntityManager

Returns

BasePdfService<T, R>

Overrides

WithManager.constructor

Properties

Property	Modifier	Type	Default value	Inherited from
client	public	Client	undefined	-
manager	protected	EntityManager	undefined	WithManager.manager
routeConstructor	abstract	(data) => R	undefined	-
stationary	public	string	'BAC'	-

Methods

createPdfBuffer()

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

Core method that generates and returns the PDF bytes.

Parameters

Parameter	Type
entity	T

Returns

Promise<Buffer<ArrayBufferLike>>

Implementation of

IPdfServiceBase.createPdfBuffer

---

createRaw()

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

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

Parameters

Parameter	Type
entity	T

Returns

Promise<Buffer<ArrayBufferLike>>

Implementation of

IPdfServiceBase.createRaw

---

createTex()

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

Parameters

Parameter	Type
entity	T

Returns

Promise<Buffer<ArrayBufferLike>>

Deprecated

Use createRaw() instead

---

generator()

abstract generator(routeParams): Promise<FileResponse>;

Parameters

Parameter	Type
routeParams	R

Returns

Promise<FileResponse>

---

getFileSettings()

protected getFileSettings(fileType?): FileSettings;

Parameters

Parameter	Type	Default value
fileType	ReturnFileType	ReturnFileType.PDF

Returns

FileSettings

---

getParameters()

abstract getParameters(entity): Promise<any>;

Parameters

Parameter	Type
entity	T

Returns

Promise<any>

Implementation of

IPdfServiceBase.getParameters

---

getRouteParams()

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

Parameters

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

Returns

Promise<R>

---

getClient()

static getClient(url): Client;

Parameters

Parameter	Type
url	string

Returns

Client