https://github.com/vadimdemedes/ink-testing-library

Utilities for testing Ink apps
https://github.com/vadimdemedes/ink-testing-library

Last synced: about 2 months ago
JSON representation

Utilities for testing Ink apps

• Host: GitHub
• URL: https://github.com/vadimdemedes/ink-testing-library
• Owner: vadimdemedes
• License: mit
• Created: 2019-03-06T05:56:00.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-09-21T08:30:09.000Z (about 1 year ago)
• Last Synced: 2024-04-15T12:13:35.652Z (5 months ago)
• Language: TypeScript
• Size: 16.6 KB
• Stars: 110
• Watchers: 5
• Forks: 15
• Open Issues: 10
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

• awesome-list - ink-testing-library

README

        
# ink-testing-library ![test](https://github.com/vadimdemedes/ink-testing-library/workflows/test/badge.svg)

> Utilities for testing [Ink](https://github.com/vadimdemedes/ink) apps

## Install

```

$ npm install --save-dev ink-testing-library

```

## Usage

```jsx

import React from 'react';

import {Text} from 'ink';

import {render} from 'ink-testing-library';

const Counter = ({count}) => Count: {count};

const {lastFrame, rerender} = render();

lastFrame() === 'Count: 0'; //=> true

rerender();

lastFrame() === 'Count: 1'; //=> true

```

## API

### render(tree)

#### tree

Type: `ReactElement`

React component to render.

```jsx

render();

```

This function returns an object, which contains the following methods and properties.

#### lastFrame()

Type: `function`

Shortcut to [`stdout.lastFrame`](#lastframe-1).

#### frames

Type: `array`

Shortcut to [`stdout.frames`](#frames-1).

#### rerender(tree)

Type: `function`

##### tree

Type: `ReactElement`

Rerender root component with different props or replace with another component.

```jsx

const {rerender} = render();

rerender();

```

#### unmount()

Type: `function`

Unmount current component.

```jsx

const {unmount} = render();

unmount();

```

#### stdin

Type: `object`

##### write()

Type: `function`

Write data to current component's stdin stream.

```jsx

import {useInput, Text} from 'ink';

const Test = () => {

	useInput(input => {

		console.log(input);

		//=> 'hello'

	});

	return …;

};

const {stdin} = render();

stdin.write('hello');

```

#### stdout

Type: `object`

##### lastFrame()

Type: `function`

Return the last rendered frame (output) from stdout stream.

```jsx

const Test = () => Hello;

const {stdout} = render();

stdout.lastFrame(); //=> 'Hello'

```

##### frames

Type: `array`

Array of all rendered frames, where the last frame is also the last item in that array.

```jsx

const Counter = ({count}) => Count: {count};

const {stdout, rerender} = render();

rerender();

console.log(stdout.frames); //=> ['Count: 0', 'Count: 1']

```

#### stderr

Type: `object`

##### lastFrame()

Type: `function`

Same as [`lastFrame`](#lastframe-1) in [`stdout`](#stdout), but for stderr stream.

##### frames

Type: `array`

Same as [`frames`](#frames-1) in [`stdout`](#stdout), but for stderr stream.