TagScript

Interface: RunOptions

Defined in: packages/tagscript/src/lib/Interpreter/Interpreter.ts:16

The options a single render accepts.

Properties

charLimit?

Defined in: packages/tagscript/src/lib/Interpreter/Interpreter.ts:23

The maximum number of characters the render may produce. Going over it rejects with a WorkloadExceededError. null means no limit.

Default Value

null

keyValues?

Defined in: packages/tagscript/src/lib/Interpreter/Interpreter.ts:30

Arbitrary data for your own parsers to read at ctx.response.keyValues. The interpreter never touches it.

Default Value

{}

parenType?

Defined in: packages/tagscript/src/lib/Interpreter/Interpreter.ts:36

Which parameter syntaxes a template may use.

Default Value

ParenType.Both

seedVariables?

Defined in: packages/tagscript/src/lib/Interpreter/Interpreter.ts:42

Variables the template can read, as name to transformer.

Index Signature

[key: string]: ITransformer

Default Value

{}

skipRanges?

Defined in: packages/tagscript/src/lib/Interpreter/Interpreter.ts:49

Ranges of the template to leave exactly as written, such as markdown code blocks. A tag that starts inside one is not run. Offsets are into the template.

Default Value

[]

spans?

Defined in: packages/tagscript/src/lib/Interpreter/Interpreter.ts:65

Record which ranges of the body came from a tag, on Response.spans.

Off by default. The bookkeeping costs time proportional to the square of the tag count, and a render that only wants the body should not pay for it.

Default Value

false

tagLimit?

Defined in: packages/tagscript/src/lib/Interpreter/Interpreter.ts:56

The maximum number of characters read from inside one \{...\}. The rest of that tag body is dropped.

Default Value

2000

trace?

Defined in: packages/tagscript/src/lib/Interpreter/Interpreter.ts:72

Record every step of the render on Response.trace. Off by default, because it keeps a copy of the body per tag.

Default Value

false