Skip to main content

ReactEmailParameters

@webda/react-email

Class: ReactEmailParameters

Defined in: packages/react-email/src/react-email.service.ts:9

Parameters of the ReactEmailService

Extends​

  • ServiceParameters

Constructors​

Constructor​

new ReactEmailParameters(): ReactEmailParameters

Returns​

ReactEmailParameters

Inherited from​

ServiceParameters.constructor

Properties​

fixApostrophes?​

optional fixApostrophes?: boolean

Defined in: packages/react-email/src/react-email.service.ts:29

Replace ' by ' in the html

Default​

true

output?​

optional output?: string

Defined in: packages/react-email/src/react-email.service.ts:19

Folder where the mustache templates are written, relative to the working directory

Default​

"./templates"

pretty?​

optional pretty?: boolean

Defined in: packages/react-email/src/react-email.service.ts:24

Pretty print the html

Default​

true

source?​

optional source?: string

Defined in: packages/react-email/src/react-email.service.ts:14

Folder containing the emails, relative to the working directory

Default​

"./emails"

sourceMap?​

optional sourceMap?: Record<string, string>

Defined in: packages/react-email/src/react-email.service.ts:33

Source to compiled prefix map, for example { "emails/": "lib/emails/" }

type​

type: string

Defined in: packages/core/lib/services/serviceparameters.d.ts:9

Type of the service

Inherited from​

ServiceParameters.type

Methods​

load()​

load(params?): this

Defined in: packages/react-email/src/react-email.service.ts:39

Parameters​

params?​

any = {}

raw parameters

Returns​

this

this with the defaults

Overrides​

ServiceParameters.load

update()​

update(params, delta): this

Defined in: packages/core/lib/application/parameters.d.ts:21

Update parameters and call watchers if a parameter was changed

Parameters​

params​

any

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

ServiceParameters.update

with()​

with(callback): this

Defined in: packages/core/lib/application/parameters.d.ts:27

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

ServiceParameters.with