Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Plier

Utility for executing multiple tests, organized into their respective suites. Used by both CLI and vscode-ply.

Hierarchy

  • EventEmitter
    • Plier

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly logger

logger: Logger

general purpose logger not associated with suite (goes to console)

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Accessors

options

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): Plier

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Plier

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

find

  • find(paths: string[]): Promise<string[]>

  • Finds plyees from suites and tests.

    Parameters

    • paths: string[]

      suite/test paths

    Returns Promise<string[]>

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): Plier

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Plier

on

  • on(event: string | symbol, listener: (...args: any[]) => void): Plier

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Plier

once

  • once(event: string | symbol, listener: (...args: any[]) => void): Plier

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Plier

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): Plier

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Plier

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): Plier

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Plier

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): Plier

  • Parameters

    • Optional event: string | symbol

    Returns Plier

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): Plier

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Plier

run

  • run(plyees: string[], runOptions?: RunOptions, plyVersion?: string): Promise<Result[]>

  • Plyees should be test paths (not suites). TODO: DRY this out

    Parameters

    • plyees: string[]
    • Optional runOptions: RunOptions
    • Optional plyVersion: string

    Returns Promise<Result[]>

setMaxListeners

  • setMaxListeners(n: number): Plier

  • Parameters

    • n: number

    Returns Plier

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

  • Parameters

    • emitter: EventEmitter
    • event: string

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string): Promise<any[]>

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string

    Returns Promise<any[]>

Generated using TypeDoc