Class DocxRenderer`Abstract`

Abstract base DOCX renderer for generating Word documents from resume data.

This class provides common utilities and helper methods for DOCX rendering. Specific templates should extend this class and implement the abstract section rendering methods.

Unlike other renderers that extend Renderer and return strings, this renderer produces DOCX binary output via the docx library. The abstract methods are implemented to return Paragraph arrays for compatibility, but the main output is via render() which returns a Promise.

Hierarchy (View Summary)

Renderer<Paragraph[]>
- DocxRenderer
  - CalmDocxRenderer

Constructors

constructor

new DocxRenderer(
    resume: Resume,
    layoutIndex: number,
    summaryParser?: Parser,
): DocxRenderer
Constructor for the DocxRenderer class.
Parameters
- resume: Resume
  The resume object
- layoutIndex: number
  The index of the selected layout to use.
- summaryParser: Parser = ...
  The summary parser used to parse summary field in various sections.
Returns DocxRenderer
Overrides Renderer<Paragraph[]>.constructor
- Defined in packages/core/src/renderer/docx/base.ts:95

Properties

`Protected`codeGenerator

codeGenerator: DocxCodeGenerator

Code generator for generating DOCX paragraphs from AST nodes.

layoutIndex

layoutIndex: number

resume

resume: Resume

`Protected`summaryParser

summaryParser: Parser

Markdown parser instance used for parsing summary fields.

Accessors

`Protected`showIcons

get showIcons(): boolean
Check whether to show icons in the document.

Returns boolean
Whether to show icons
- Defined in packages/core/src/renderer/docx/base.ts:173

`Protected`showUrls

get showUrls(): boolean
Whether to show raw URLs or hide them behind reasonable text.

Returns boolean
- Defined in packages/core/src/renderer/docx/base.ts:194

Methods

`Protected`buildDocumentChildren

buildDocumentChildren(): Paragraph[]
Build the document children paragraphs.

Returns Paragraph[]
Array of paragraphs for the document
- Defined in packages/core/src/renderer/docx/base.ts:631

`Protected`createBoldLabelParagraph

createBoldLabelParagraph(label: string, value: string): Paragraph
Create a text paragraph with a bold label prefix and normal value suffix.
Parameters
- label: string
  The bold label text (e.g., "Keywords: ")
- value: string
  The normal value text
Returns Paragraph
A DOCX paragraph with mixed bold/normal text
- Defined in packages/core/src/renderer/docx/base.ts:400

`Protected`createDetailParagraph

createDetailParagraph(text: string): Paragraph
Create a detail line paragraph (italicized).
Parameters
- text: string
  The text content
Returns Paragraph
A DOCX paragraph with italic styling
- Defined in packages/core/src/renderer/docx/base.ts:425

`Protected`createDocument

createDocument(): File_2
Create a Document instance from the rendered sections.

Returns File_2
A DOCX Document instance
- Defined in packages/core/src/renderer/docx/base.ts:645

`Protected`createMarkdownParagraphs

createMarkdownParagraphs(markdown: string): Paragraph[]
Convert a markdown string to DOCX paragraphs.

This method parses markdown content and converts it to appropriate DOCX paragraph elements, supporting:
- Plain text paragraphs
- Bold and italic formatting
- Links (as external hyperlinks)
- Bullet lists (unordered lists)
- Ordered lists
Parameters
- markdown: string
  The markdown string to convert
Returns Paragraph[]
Array of DOCX paragraphs
- Defined in packages/core/src/renderer/docx/base.ts:505

`Protected`createSectionHeading

createSectionHeading(text: string): Paragraph
Create a section heading paragraph with horizontal rule.
Parameters
- text: string
  The heading text
Returns Paragraph
A DOCX paragraph with heading styling
- Defined in packages/core/src/renderer/docx/base.ts:322

`Protected`createSubsectionHeading

createSubsectionHeading(text: string): Paragraph
Create a subsection heading paragraph.
Parameters
- text: string
  The heading text
Returns Paragraph
A DOCX paragraph with subheading styling
- Defined in packages/core/src/renderer/docx/base.ts:356

`Protected`createTextParagraph

createTextParagraph(text: string): Paragraph
Create a normal text paragraph.
Parameters
- text: string
  The text content
Returns Paragraph
A DOCX paragraph
- Defined in packages/core/src/renderer/docx/base.ts:382

`Protected`createTwoColumnParagraph

createTwoColumnParagraph(
    leftContent: (TextRun | ExternalHyperlink)[],
    rightContent?: (TextRun | ExternalHyperlink)[],
    spacing?: { after?: number; line?: number },
    tabSize?: number,
): Paragraph
Create a two-column layout paragraph with optional right-aligned content.

Uses a right-aligned tab stop to push the right content to the margin. Both left and right content can contain TextRun or ExternalHyperlink nodes.
Parameters
- leftContent: (TextRun | ExternalHyperlink)[]
  Array of TextRun or ExternalHyperlink for the left column
- OptionalrightContent: (TextRun | ExternalHyperlink)[]
  Optional array of TextRun or ExternalHyperlink for the right column
- Optionalspacing: { after?: number; line?: number }
  Optional spacing configuration for the paragraph
- OptionaltabSize: number
Returns Paragraph
A DOCX paragraph with two-column layout
- Defined in packages/core/src/renderer/docx/base.ts:449

`Protected`getBaseFontSize

getBaseFontSize(): number
Get the base font size in half-points from typography settings.

Returns number
Font size in half-points
- Defined in packages/core/src/renderer/docx/base.ts:115

`Protected`getFontFamily

getFontFamily(): string
Get the font family from typography settings.

Returns string
Font family name or undefined for default
- Defined in packages/core/src/renderer/docx/base.ts:129

`Protected`getLineSpacing

getLineSpacing(): number
Get the line spacing in twips from typography settings.

Returns number
Line spacing value
- Defined in packages/core/src/renderer/docx/base.ts:142

`Protected`getLineSpacingName

getLineSpacingName(): "tight" | "snug" | "normal" | "relaxed" | "loose"
Get the line spacing name from typography settings.

Returns "tight" | "snug" | "normal" | "relaxed" | "loose"
Line spacing option name
- Defined in packages/core/src/renderer/docx/base.ts:160

`Protected`getPageMargins

getPageMargins(): { bottom: number; left: number; right: number; top: number }
Get page margins from layout settings.

Returns { bottom: number; left: number; right: number; top: number }
Page margins in twips
- Defined in packages/core/src/renderer/docx/base.ts:231

`Protected`getPaperSize

getPaperSize(): { height: number; width: number }
Get the paper size dimensions in twips for the document.

DOCX page dimensions are specified in twips (1/20 of a point).

Returns { height: number; width: number }
Paper size dimensions
- Defined in packages/core/src/renderer/docx/base.ts:278

`Protected`getScaledFontSize

getScaledFontSize(scale: number): number
Get scaled font size based on base font size.
Parameters
- scale: number
  Scale factor (e.g., 2 for title = 2x base size)
Returns number
Scaled font size in half-points
- Defined in packages/core/src/renderer/docx/base.ts:187

`Protected`getShowPageNumbers

getShowPageNumbers(): boolean
Check whether to show page numbers.

Returns boolean
Whether to show page numbers
- Defined in packages/core/src/renderer/docx/base.ts:263

`Protected`joinSections

joinSections(sections: Paragraph[][]): Paragraph[]
Join multiple rendered sections into a single output.
Parameters
- sections: Paragraph[][]
  The sections to join
Returns Paragraph[]
The joined sections
Overrides Renderer.joinSections
- Defined in packages/core/src/renderer/docx/base.ts:301

render

render(): Promise<Uint8Array<ArrayBufferLike>>
Render the resume as a DOCX Uint8Array.

Returns Promise<Uint8Array<ArrayBufferLike>>
A promise that resolves to the DOCX data
Overrides Renderer.render
- Defined in packages/core/src/renderer/docx/base.ts:695

`Abstract`renderAwards

renderAwards(): Paragraph[]
Create paragraphs for the awards section.

Returns Paragraph[]
Array of DOCX paragraphs for awards
Overrides Renderer.renderAwards
- Defined in packages/core/src/renderer/docx/base.ts:580

`Abstract`renderBasics

renderBasics(): Paragraph[]
Create paragraphs for the basics section.

Returns Paragraph[]
Array of DOCX paragraphs for basics
Overrides Renderer.renderBasics
- Defined in packages/core/src/renderer/docx/base.ts:524

`Abstract`renderCertificates

renderCertificates(): Paragraph[]
Create paragraphs for the certificates section.

Returns Paragraph[]
Array of DOCX paragraphs for certificates
Overrides Renderer.renderCertificates
- Defined in packages/core/src/renderer/docx/base.ts:587

renderDocumentBlob

renderDocumentBlob(): Promise<Blob>
Render the resume as a DOCX Blob.

Returns Promise<Blob>
A promise that resolves to the DOCX Blob
- Defined in packages/core/src/renderer/docx/base.ts:706

`Abstract`renderEducation

renderEducation(): Paragraph[]
Create paragraphs for the education section.

Returns Paragraph[]
Array of DOCX paragraphs for education
Overrides Renderer.renderEducation
- Defined in packages/core/src/renderer/docx/base.ts:552

`Abstract`renderInterests

renderInterests(): Paragraph[]
Create paragraphs for the interests section.

Returns Paragraph[]
Array of DOCX paragraphs for interests
Overrides Renderer.renderInterests
- Defined in packages/core/src/renderer/docx/base.ts:615

`Abstract`renderLanguages

renderLanguages(): Paragraph[]
Create paragraphs for the languages section.

Returns Paragraph[]
Array of DOCX paragraphs for languages
Overrides Renderer.renderLanguages
- Defined in packages/core/src/renderer/docx/base.ts:566

`Abstract`renderLocation

renderLocation(): Paragraph[]
Create paragraphs for the location section.

Returns Paragraph[]
Array of DOCX paragraphs for location
Overrides Renderer.renderLocation
- Defined in packages/core/src/renderer/docx/base.ts:531

`Protected`renderOrderedSections

renderOrderedSections(): Paragraph[]
Render sections in the specified order.

Returns Paragraph[]
The rendered sections in the specified order
Inherited from Renderer.renderOrderedSections
- Defined in packages/core/src/renderer/base.ts:204

renderPreamble

renderPreamble(): Paragraph[]
Render the preamble of the resume.

Returns Paragraph[]
Empty array as DOCX handled within Document directly
Overrides Renderer.renderPreamble
- Defined in packages/core/src/renderer/docx/base.ts:310

`Abstract`renderProfiles

renderProfiles(): Paragraph[]
Create paragraphs for the profiles section.

Returns Paragraph[]
Array of DOCX paragraphs for profiles
Overrides Renderer.renderProfiles
- Defined in packages/core/src/renderer/docx/base.ts:538

`Abstract`renderProjects

renderProjects(): Paragraph[]
Create paragraphs for the projects section.

Returns Paragraph[]
Array of DOCX paragraphs for projects
Overrides Renderer.renderProjects
- Defined in packages/core/src/renderer/docx/base.ts:608

`Abstract`renderPublications

renderPublications(): Paragraph[]
Create paragraphs for the publications section.

Returns Paragraph[]
Array of DOCX paragraphs for publications
Overrides Renderer.renderPublications
- Defined in packages/core/src/renderer/docx/base.ts:594

`Abstract`renderReferences

renderReferences(): Paragraph[]
Create paragraphs for the references section.

Returns Paragraph[]
Array of DOCX paragraphs for references
Overrides Renderer.renderReferences
- Defined in packages/core/src/renderer/docx/base.ts:601

`Abstract`renderSkills

renderSkills(): Paragraph[]
Create paragraphs for the skills section.

Returns Paragraph[]
Array of DOCX paragraphs for skills
Overrides Renderer.renderSkills
- Defined in packages/core/src/renderer/docx/base.ts:573

`Abstract`renderSummary

renderSummary(): Paragraph[]
Create paragraphs for the summary section.

Returns Paragraph[]
Array of DOCX paragraphs for summary
Overrides Renderer.renderSummary
- Defined in packages/core/src/renderer/docx/base.ts:545

`Abstract`renderVolunteer

renderVolunteer(): Paragraph[]
Create paragraphs for the volunteer section.

Returns Paragraph[]
Array of DOCX paragraphs for volunteer
Overrides Renderer.renderVolunteer
- Defined in packages/core/src/renderer/docx/base.ts:622

`Abstract`renderWork

renderWork(): Paragraph[]
Create paragraphs for the work section.

Returns Paragraph[]
Array of DOCX paragraphs for work
Overrides Renderer.renderWork
- Defined in packages/core/src/renderer/docx/base.ts:559

Class DocxRendererAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns DocxRenderer

Properties

ProtectedcodeGenerator

layoutIndex

resume

ProtectedsummaryParser

Accessors

ProtectedshowIcons

Returns boolean

ProtectedshowUrls

Returns boolean

Methods

ProtectedbuildDocumentChildren

Returns Paragraph[]

ProtectedcreateBoldLabelParagraph

Parameters

Returns Paragraph

ProtectedcreateDetailParagraph

Parameters

Returns Paragraph

ProtectedcreateDocument

Returns File_2

ProtectedcreateMarkdownParagraphs

Parameters

Returns Paragraph[]

ProtectedcreateSectionHeading

Parameters

Returns Paragraph

ProtectedcreateSubsectionHeading

Parameters

Returns Paragraph

ProtectedcreateTextParagraph

Parameters

Returns Paragraph

ProtectedcreateTwoColumnParagraph

Parameters

Returns Paragraph

ProtectedgetBaseFontSize

Returns number

ProtectedgetFontFamily

Returns string

ProtectedgetLineSpacing

Returns number

ProtectedgetLineSpacingName

Returns "tight" | "snug" | "normal" | "relaxed" | "loose"

ProtectedgetPageMargins

Returns { bottom: number; left: number; right: number; top: number }

ProtectedgetPaperSize

Returns { height: number; width: number }

ProtectedgetScaledFontSize

Parameters

Returns number

ProtectedgetShowPageNumbers

Returns boolean

ProtectedjoinSections

Parameters

Returns Paragraph[]

render

Returns Promise<Uint8Array<ArrayBufferLike>>

AbstractrenderAwards

Returns Paragraph[]

AbstractrenderBasics

Returns Paragraph[]

AbstractrenderCertificates

Returns Paragraph[]

renderDocumentBlob

Returns Promise<Blob>

AbstractrenderEducation

Returns Paragraph[]

AbstractrenderInterests

Class DocxRenderer`Abstract`

`Protected`codeGenerator

`Protected`summaryParser

`Protected`showIcons

`Protected`showUrls

`Protected`buildDocumentChildren

`Protected`createBoldLabelParagraph

`Protected`createDetailParagraph

`Protected`createDocument

`Protected`createMarkdownParagraphs

`Protected`createSectionHeading

`Protected`createSubsectionHeading

`Protected`createTextParagraph

`Protected`createTwoColumnParagraph

`Protected`getBaseFontSize

`Protected`getFontFamily

`Protected`getLineSpacing

`Protected`getLineSpacingName

`Protected`getPageMargins

`Protected`getPaperSize

`Protected`getScaledFontSize

`Protected`getShowPageNumbers

`Protected`joinSections

`Abstract`renderAwards

`Abstract`renderBasics

`Abstract`renderCertificates

`Abstract`renderEducation

`Abstract`renderInterests

`Abstract`renderLanguages

`Abstract`renderLocation

`Protected`renderOrderedSections

`Abstract`renderProfiles

`Abstract`renderProjects

`Abstract`renderPublications

`Abstract`renderReferences

`Abstract`renderSkills

`Abstract`renderSummary

`Abstract`renderVolunteer

`Abstract`renderWork