Skip to content

docs: update jest README with testing examples and removed react setup instructions that are not currently available. #889

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update jest README with testing examples and removed react setup instructions that are not currently available. #889

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions packages/tooling/jest/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,31 @@ Then in `jest.config.js` add `@launchdarkly/jest/{framework}` to setupFiles:
```js
// jest.config.js
module.exports = {
// for react
setupFiles: ['@launchdarkly/jest/react'],

// for react-native
setupFiles: ['@launchdarkly/jest/react-native'],
};
```

## Quickstart

TODO:
describe('Welcome component test', () => {
afterEach(() => {
resetLDMocks();
});

test('mock boolean flag correctly', () => {
mockFlags({ 'my-boolean-flag': true });
render(<Welcome />);
expect(screen.getByText('Flag value is true')).toBeTruthy();
});

test('mock ldClient correctly', () => {
const current = useLDClient();

current?.track('event');
expect(current.track).toHaveBeenCalledTimes(1);
});
});

## Developing this package

Expand Down