ply

Index

Namespaces

Enumerations

LogLevel

Classes

Type aliases

Variables

Functions

Type aliases

CodeLine

CodeLine: { code: string; comment?: string }

Type declaration

code: string
Optional comment?: string

Diff

Diff: { added?: boolean; count: number; ignored?: boolean; removed?: boolean; value: string }

jsdiff object

Type declaration

Optional added?: boolean
count: number
Optional ignored?: boolean
Optional removed?: boolean
value: string

ResultStatus

ResultStatus: "Pending" | "Passed" | "Failed" | "Errored" | "Submitted"

TestType

TestType: "request" | "case" | "flow"

step type means flow step(s) in isolation

Variables

Const PLY_CONFIGS

PLY_CONFIGS: string[] = ...

default

default: Ply

Const defaultOptions

defaultOptions: PlyexOptions = ...

Functions

after

after(target: any, propertyKey: string, descriptor: PropertyDescriptor): void
after(tests: string): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void

- Defined in src/decorators.ts:109
Invoked after tests.

Parameters
- target: any
- propertyKey: string
- descriptor: PropertyDescriptor
Returns void
- Defined in src/decorators.ts:110
Parameters
- tests: string
Returns (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void
- - (target: any, propertyKey: string, descriptor: PropertyDescriptor): void
  - Parameters
    - target: any
    - propertyKey: string
    - descriptor: PropertyDescriptor
    Returns void

before

before(target: any, propertyKey: string, descriptor: PropertyDescriptor): void
before(tests: string): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void

- Defined in src/decorators.ts:80
Invoked before tests.

Parameters
- target: any
- propertyKey: string
- descriptor: PropertyDescriptor
Returns void
- Defined in src/decorators.ts:81
Parameters
- tests: string
Returns (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void
- - (target: any, propertyKey: string, descriptor: PropertyDescriptor): void
  - Parameters
    - target: any
    - propertyKey: string
    - descriptor: PropertyDescriptor
    Returns void

dumpYaml

dumpYaml(obj: object, indent: number): string

- Defined in src/yaml.ts:9
Parameters
- obj: object
- indent: number
Returns string

loadYaml

loadYaml(file: string, contents: string, assignLines?: boolean): any

- Defined in src/yaml.ts:13
Parameters
- file: string
- contents: string
- assignLines: boolean = false
Returns any

replace

replace(template: string, context: object, logger: Logger, trusted?: boolean): string

- Defined in src/subst.ts:85
Replaces template expressions with values from context (per line), with template literal syntax. Untrusted supports a limited subset of template literal. Ignores regular expressions starting with ${~. * Resulting newlines are always \n.

Parameters
- template: string
- context: object
- logger: Logger
- trusted: boolean = false
Returns string

suite

suite(target: ClassTarget): void
suite(name: string): (target: ClassTarget) => void

- Defined in src/decorators.ts:16
If name arg is not specified, class name is suite name.

Parameters
- target: ClassTarget
Returns void
- Defined in src/decorators.ts:17
Parameters
- name: string
Returns (target: ClassTarget) => void
- - (target: ClassTarget): void
  - Parameters
    - target: ClassTarget
    Returns void

test

test(target: any, propertyKey: string, descriptor: PropertyDescriptor): void
test(name: string): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void

- Defined in src/decorators.ts:49
If name arg is not specified, function name is test name.

Parameters
- target: any
- propertyKey: string
- descriptor: PropertyDescriptor
Returns void
- Defined in src/decorators.ts:50
Parameters
- name: string
Returns (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void
- - (target: any, propertyKey: string, descriptor: PropertyDescriptor): void
  - Parameters
    - target: any
    - propertyKey: string
    - descriptor: PropertyDescriptor
    Returns void

Generated using TypeDoc