Class ResultSet

Provides convenient access to the stream of search results.

Index

Constructors

Accessors

all first stream

Constructors

constructor

new ResultSet(command: string, finder: Finder): ResultSet
Creates a new result set.
Parameters
- command: string
  The searched command.
- finder: Finder
  The finder used to perform the search.
Returns ResultSet
- Defined in ResultSet.ts:24

Accessors

all

get all(): Promise<string[]>
All instances of the searched command.

Returns Promise<string[]>
- Defined in ResultSet.ts:32

first

get first(): Promise<string>
The first instance of the searched command.

Returns Promise<string>
- Defined in ResultSet.ts:39

stream

get stream(): AsyncGenerator<string, void>
A stream of instances of the searched command.

Returns AsyncGenerator<string, void>
- Defined in ResultSet.ts:49