parrot-core abstracts the matching, logging, and resolving functionality of Parrot away from each implementation. parrot-middleware and parrot-fetch use parrot-core and any new implementations could extend parrot-core in a similar way.

Example Implementation

``js
import Parrot from 'parrot-core';

class ParrotNew extends Parrot {
constructor(scenarios) {
super(scenarios);
// any constructor logic that is needed
}

normalizeRequest = request => {
// conform incoming requests to match the scenarios structure
};

resolver = request => response => {
// resolve the matched response to the implementation platform
};
}

export default ParrotNew;
`

Access Methods

parrot-core also defines several methods that can be used to interact with the scenarios that are passed in.

$3

Returns the name of the currently active scenario.

$3

Sets the currently active scenario.

#### Arguments

- name (_String_): Scenario name.

$3

Returns an array of scenario objects.

$3

Sets scenarios as the array of available scenarios.

#### Arguments

- scenarios (_Array_ or _Object_): Scenarios descriptor.

$3

Returns the scenario object with matching name.

#### Arguments

- name (_String_): Scenario name.

$3

Sets the mocks for scenario with matching name.

#### Arguments

- name (_String_): Scenario name.
- mocks (_Array_): Array of mock objects.

$3

Returns the mock at index for scenario with matching name.

#### Arguments

- name (_String_): Scenario name.
- index (_Number_): Mock index.

$3

Sets the mock at index for scenario with matching name.

#### Arguments

- name (_String_): Scenario name.
- index (_Number_): Mock index.
- mock (_Object_): Mock object.

Utility Methods

$3

Extracts the route parameters from a given path, using the specified route.

This is useful when using the manual match function.

#### Arguments

- path (_String_): Requested URL path.
- route (_String_): Express-style route with route parameters.

#### Example Usage

`javascript
const { getParams } = require('parrot-core');

const getBook = ({ url }, match) => {
const path = '/books/:bookId';
if (match({ path, method: 'GET' })) {
const { bookId } = getParams(url, path);
const requestedBook = books.find(book => book.bookId === bookId);
if (!requestedBook) {
return { status: 404 };
}
return { status: 200, body: requestedBook };
}
return null;
};
``