Class Rule

Model for Rule

Hierarchy

UniqueObject
- Rule

Index

Constructors

Properties

_id description descriptionComment elements keyword name precedingComment tagComment tags

Methods

clone replace parse

Constructors

constructor

new Rule(keyword, name, description): Rule
Parameters
- keyword: string
- name: string
- description: string
Returns Rule
Overrides UniqueObject.constructor
- Defined in node_modules/gherkin-ast/ast/rule.d.ts:28

Properties

_id

_id: string

description

description: string

Descrition of the Rule

descriptionComment

descriptionComment: Comment

Comment after the description of the Rul

elements

elements: Element[]

Elements of the Rule

keyword

keyword: string

Keyword of the Rule

name

name: string

Name of the Rule

precedingComment

precedingComment: Comment

Comment before the Rule

tagComment

tagComment: Comment

Comment before the tags

tags

tags: Tag[]

Tags of the Rule

Methods

clone

clone(): Rule
Returns Rule
- Defined in node_modules/gherkin-ast/ast/rule.d.ts:29

replace

replace(key, value): void
Parameters
- key: string | RegExp
- value: string
Returns void
- Defined in node_modules/gherkin-ast/ast/rule.d.ts:30

`Static` parse

parse(obj, comments?): Rule
Parameters
- obj: GherkinRule
- Optional comments: GherkinCommentHandler
Returns Rule
- Defined in node_modules/gherkin-ast/ast/rule.d.ts:11

Generated using TypeDoc