SudoSOS Back-end API / internal/pdf/user-report-pdf-service / UserReportPdfService

Class: UserReportPdfService<T>

UnstoredPdfService - produces bytes but does not persist. It inherits createPdfBuffer and createRaw from BasePdfService. It does not implement any stored interface.

Extends

• UnstoredPdfService<T, UserRouteParams>

Type Parameters

Type Parameter
T extends | SalesReport | BuyerReport

Constructors

Constructor

new UserReportPdfService<T>(type, manager?): UserReportPdfService<T>;

Parameters

Parameter	Type
type	UserReportParametersType
manager?	EntityManager

Returns

UserReportPdfService<T>

Overrides

UnstoredPdfService.constructor

Properties

Property	Modifier	Type	Default value	Overrides	Inherited from
client	public	Client	undefined	-	UnstoredPdfService.client
manager	protected	EntityManager	undefined	-	UnstoredPdfService.manager
routeConstructor	public	typeof UserRouteParams	UserRouteParams	UnstoredPdfService.routeConstructor	-
stationary	public	string	'BAC'	-	UnstoredPdfService.stationary

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>>

Inherited from

UnstoredPdfService.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>>

Inherited from

UnstoredPdfService.createRaw

---

createTex()

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

Parameters

Parameter	Type
entity	T

Returns

Promise<Buffer<ArrayBufferLike>>

Deprecated

Use createRaw() instead

Inherited from

UnstoredPdfService.createTex

---

generator()

generator(routeParams): Promise<FileResponse>;

Parameters

Parameter	Type
routeParams	UserRouteParams

Returns

Promise<FileResponse>

Overrides

UnstoredPdfService.generator

---

getFileSettings()

protected getFileSettings(fileType?): FileSettings;

Parameters

Parameter	Type	Default value
fileType	ReturnFileType	ReturnFileType.PDF

Returns

FileSettings

Inherited from

UnstoredPdfService.getFileSettings

---

getParameters()

getParameters(entity): Promise<UserReportParameters>;

Parameters

Parameter	Type
entity	T

Returns

Promise<UserReportParameters>

Overrides

UnstoredPdfService.getParameters

---

getRouteParams()

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

Parameters

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

Returns

Promise<UserRouteParams>

Inherited from

UnstoredPdfService.getRouteParams

---

getClient()

static getClient(url): Client;

Parameters

Parameter	Type
url	string

Returns

Client

Inherited from

UnstoredPdfService.getClient