Class Background

Model for Background

Hierarchy

Element
- Background

Index

Constructors

Properties

_id description descriptionComment keyword name precedingComment steps

Methods

clone replace useNormalStepKeywords useReadableStepKeywords parse

Constructors

constructor

new Background(keyword, name, description): Background
Parameters
- keyword: string
- name: string
- description: string
Returns Background
Inherited from Element.constructor
- Defined in node_modules/gherkin-ast/ast/element.d.ts:21

Properties

_id

_id: string

description

description: string

Description of the Element

descriptionComment

descriptionComment: Comment

Comment after the description of the Element

keyword

keyword: string

Keyword of the Element

name

name: string

Name of the Element

precedingComment

precedingComment: Comment

Comment before the Element

steps

steps: Step[]

Steps of the Element

Methods

clone

clone(): Background
Returns Background
Overrides Element.clone
- Defined in node_modules/gherkin-ast/ast/background.d.ts:9

replace

replace(key, value): void
Parameters
- key: string | RegExp
- value: string
Returns void
Inherited from Element.replace
- Defined in node_modules/gherkin-ast/ast/element.d.ts:23

useNormalStepKeywords

useNormalStepKeywords(): void
Returns void
Inherited from Element.useNormalStepKeywords
- Defined in node_modules/gherkin-ast/ast/element.d.ts:24

useReadableStepKeywords

useReadableStepKeywords(): void
Returns void
Inherited from Element.useReadableStepKeywords
- Defined in node_modules/gherkin-ast/ast/element.d.ts:25

`Static` parse

parse(obj, comments?): Background
Parameters
- obj: GherkinBackground
- Optional comments: GherkinCommentHandler
Returns Background
- Defined in node_modules/gherkin-ast/ast/background.d.ts:8

Generated using TypeDoc