Skip to main content

PdfTemplatesStore

@quik/pdf

@quik/pdf / PdfTemplatesStore

Variable: PdfTemplatesStore

const PdfTemplatesStore: object

Defined in: pdf/src/stores/templates.ts:150

API for loading and retrieving PDF templates.

Type Declaration​

clear​

clear: () => void = clearTemplates

Clear all loaded templates from memory.

Returns​

void

get​

get: (template) => QPdfTemplateDefinition = getTemplate

Retrieve a template definition by name.

Parameters​

template​

string

Template key to fetch.

Returns​

QPdfTemplateDefinition

load​

load: (module, ...folders) => Promise<void> = loadTemplates

Load PDF templates from folders.

Parameters​

module​

string

Module name for template namespacing.

folders​

...string[]

One or more folders containing JSON or YAML templates.

Returns​

Promise<void>

register​

register: (name, definition) => void = registerTemplate

Register a template definition programmatically.

Parameters​

name​

string

Template key.

definition​

QPdfTemplateDefinition

Template definition.

Returns​

void

reload​

reload: (template?) => void = reloadTemplates

Reload templates from disk.

Parameters​

template?​

string

Optional template key to reload.

Returns​

void

set​

set: (name, definition, options?) => void = setTemplate

Set a template definition with configurable replace behavior.

Parameters​

name​

string

Template key.

definition​

QPdfTemplateDefinition

Template definition.

options?​

QPdfSetTemplateOptions = ...

Set options.

Returns​

void

upsert​

upsert: (name, definition) => void = upsertTemplate

Upsert a template definition.

Parameters​

name​

string

Template key.

definition​

QPdfTemplateDefinition

Template definition.

Returns​

void