Skip to main content

Interface: AnyTag

Hierarchy​

  • Tag

    ↳ AnyTag

Properties​

attributesSchema​

• Optional attributesSchema: AnySchema

JSON schema of the attributes list

Inherited from​

Tag.attributesSchema

Defined in​

bluehawk/tags/Tag.ts:21

description​

• Optional description: string

A helpful description of what the tag is supposed to do

Inherited from​

Tag.description

Defined in​

bluehawk/tags/Tag.ts:16

name​

• name: string

The tag name. For block tags this should not include -start or -end.

Inherited from​

Tag.name

Defined in​

bluehawk/tags/Tag.ts:11

process​

• process: (request: ProcessRequest<AnyTagNode>) => NotPromise

Type declaration​

▸ (request): NotPromise

Parameters​
NameType
requestProcessRequest<AnyTagNode>
Returns​

NotPromise

Defined in​

bluehawk/tags/Tag.ts:54

rules​

• Optional rules: Rule[]

Validator rules to determine if the tag meets requirements before processing is possible

Inherited from​

Tag.rules

Defined in​

bluehawk/tags/Tag.ts:45

shorthandArgsAttributeName​

• Optional shorthandArgsAttributeName: string

The attribute name that shorthand arguments map to. If not provided, then shorthands are rejected.

Example: given shorthandArgsAttributeName = "id", the following shorthand:

:some-tag-start: somename somename2

would map to the following attribute list:

:some-tag-start: { "id": ["somename", "somename2"] }

Inherited from​

Tag.shorthandArgsAttributeName

Defined in​

bluehawk/tags/Tag.ts:39

supportsBlockMode​

• supportsBlockMode: boolean

Defined in​

bluehawk/tags/Tag.ts:52

supportsLineMode​

• supportsLineMode: boolean

Defined in​

bluehawk/tags/Tag.ts:53