Skip to content

Commit

Permalink
api report/docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
davidjgoss committed Mar 21, 2022
1 parent ff7681d commit a808901
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/api/cucumber.loadsources.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@cucumber/cucumber](./cucumber.md) &gt; [loadSources](./cucumber.loadsources.md)

## loadSources() function

Load and parse features, produce a filtered and ordered test plan and/or parse errors.

<b>Signature:</b>

```typescript
export declare function loadSources(coordinates: ISourcesCoordinates, environment?: IRunEnvironment): Promise<ILoadSourcesResult>;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| coordinates | [ISourcesCoordinates](./cucumber.isourcescoordinates.md) | Coordinates required to find features |
| environment | [IRunEnvironment](./cucumber.irunenvironment.md) | Project environment. |

<b>Returns:</b>

Promise&lt;[ILoadSourcesResult](./cucumber.iloadsourcesresult.md)<!-- -->&gt;

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

Expand Down
3 changes: 3 additions & 0 deletions reports/cucumber.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,9 @@ export type ISupportCodeCoordinatesOrLibrary = ISupportCodeCoordinates | ISuppor
// @public
export function loadConfiguration(options?: ILoadConfigurationOptions, environment?: IRunEnvironment): Promise<IResolvedConfiguration>;

// @public
export function loadSources(coordinates: ISourcesCoordinates, environment?: IRunEnvironment): Promise<ILoadSourcesResult>;

// @public
export function loadSupport(options: ILoadSupportOptions, environment?: IRunEnvironment): Promise<ISupportCodeLibrary>;

Expand Down
7 changes: 7 additions & 0 deletions src/api/load_sources.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,13 @@ import { Console } from 'console'
import { mergeEnvironment } from './environment'
import { getFilteredPicklesAndErrors } from './gherkin'

/**
* Load and parse features, produce a filtered and ordered test plan and/or parse errors.
*
* @public
* @param coordinates - Coordinates required to find features
* @param environment - Project environment.
*/
export async function loadSources(
coordinates: ISourcesCoordinates,
environment: IRunEnvironment = {}
Expand Down

0 comments on commit a808901

Please sign in to comment.