Skip to content

Commit a808901

Browse files
committed
api report/docs update
1 parent ff7681d commit a808901

File tree

4 files changed

+36
-0
lines changed

4 files changed

+36
-0
lines changed

docs/api/cucumber.loadsources.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@cucumber/cucumber](./cucumber.md) &gt; [loadSources](./cucumber.loadsources.md)
4+
5+
## loadSources() function
6+
7+
Load and parse features, produce a filtered and ordered test plan and/or parse errors.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export declare function loadSources(coordinates: ISourcesCoordinates, environment?: IRunEnvironment): Promise<ILoadSourcesResult>;
13+
```
14+
15+
## Parameters
16+
17+
| Parameter | Type | Description |
18+
| --- | --- | --- |
19+
| coordinates | [ISourcesCoordinates](./cucumber.isourcescoordinates.md) | Coordinates required to find features |
20+
| environment | [IRunEnvironment](./cucumber.irunenvironment.md) | Project environment. |
21+
22+
<b>Returns:</b>
23+
24+
Promise&lt;[ILoadSourcesResult](./cucumber.iloadsourcesresult.md)<!-- -->&gt;
25+

docs/api/cucumber.md

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ These docs cover the API used for running Cucumber programmatically. The entry p
1515
| Function | Description |
1616
| --- | --- |
1717
| [loadConfiguration(options, environment)](./cucumber.loadconfiguration.md) | Load user-authored configuration to be used in a test run. |
18+
| [loadSources(coordinates, environment)](./cucumber.loadsources.md) | Load and parse features, produce a filtered and ordered test plan and/or parse errors. |
1819
| [loadSupport(options, environment)](./cucumber.loadsupport.md) | Load support code for use in test runs. |
1920
| [runCucumber(configuration, environment, onMessage)](./cucumber.runcucumber.md) | Execute a Cucumber test run. |
2021

reports/cucumber.api.md

+3
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,9 @@ export type ISupportCodeCoordinatesOrLibrary = ISupportCodeCoordinates | ISuppor
169169
// @public
170170
export function loadConfiguration(options?: ILoadConfigurationOptions, environment?: IRunEnvironment): Promise<IResolvedConfiguration>;
171171

172+
// @public
173+
export function loadSources(coordinates: ISourcesCoordinates, environment?: IRunEnvironment): Promise<ILoadSourcesResult>;
174+
172175
// @public
173176
export function loadSupport(options: ILoadSupportOptions, environment?: IRunEnvironment): Promise<ISupportCodeLibrary>;
174177

src/api/load_sources.ts

+7
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,13 @@ import { Console } from 'console'
1111
import { mergeEnvironment } from './environment'
1212
import { getFilteredPicklesAndErrors } from './gherkin'
1313

14+
/**
15+
* Load and parse features, produce a filtered and ordered test plan and/or parse errors.
16+
*
17+
* @public
18+
* @param coordinates - Coordinates required to find features
19+
* @param environment - Project environment.
20+
*/
1421
export async function loadSources(
1522
coordinates: ISourcesCoordinates,
1623
environment: IRunEnvironment = {}

0 commit comments

Comments
 (0)