Class ResultPaths

Hierarchy

ResultPaths

Index

Properties

Methods

Properties

Readonly actual

actual: Storage

Readonly expected

expected: Retrieval

isFlowResult

isFlowResult: boolean = false

Readonly log

Readonly options

options: Options

Readonly runs

runs: Runs

Methods

expectedExists

expectedExists(name?: string, instNum?: number): Promise<boolean>

- Defined in src/result.ts:422
Parameters
- Optional name: string
- instNum: number = 0
Returns Promise<boolean>

flowInstanceFromActual

flowInstanceFromActual(flowPath: string): undefined | FlowInstance

- Defined in src/result.ts:478
Parameters
- flowPath: string
Returns undefined | FlowInstance

getActualYaml

getActualYaml(name?: string, instNum?: number): Yaml

- Defined in src/result.ts:440
Newlines are always \n. Trailing \n is appended.

Parameters
- Optional name: string
- instNum: number = 0
Returns Yaml

getExpectedYaml

getExpectedYaml(name?: string, instNum?: number): Promise<Yaml>

- Defined in src/result.ts:365
Newlines are always \n.

Parameters
- Optional name: string
- instNum: number = 0
Returns Promise<Yaml>

responsesFromActual

responsesFromActual(): {}

- Defined in src/result.ts:470
Returns {}
- [key: string]: Response & { source: string }

Static create

create(options: PlyOptions, retrieval: Retrieval, suiteName?: string): Promise<ResultPaths>

- Defined in src/result.ts:278
Figures out locations and file extensions for results. Result file path relative to configured result location is the same as retrieval relative to configured tests location.

Parameters
- options: PlyOptions
- retrieval: Retrieval
- suiteName: string = retrieval.location.base
Returns Promise<ResultPaths>

Static createSync

createSync(options: PlyOptions, retrieval: Retrieval, suiteName?: string): ResultPaths

- Defined in src/result.ts:307
Figures out locations and file extensions for results. Result file path relative to configured result location is the same as retrieval relative to configured tests location.

Parameters
- options: PlyOptions
- retrieval: Retrieval
- suiteName: string = retrieval.location.base
Returns ResultPaths

Static extractById

extractById(yamlObj: any, id: string, instNum: number, indent?: number): any

- Defined in src/result.ts:334
Flow step result by id

Parameters
- yamlObj: any
- id: string
- instNum: number
- indent: number = 2
Returns any

Generated using TypeDoc