Skip to content

docs: add typescript & angular usage section #10

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

Merged
merged 2 commits into from
Dec 18, 2020
Merged

docs: add typescript & angular usage section #10

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
471c3d0
docs: add typescript & angular usage section
brrianalexis Dec 15, 2020
7ae0816
docs: usage section for typescript
brrianalexis Dec 17, 2020
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
16 changes: 15 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ yarn add --dev @testing-library/jasmine-dom

## Usage

### With JavaScript

You should have a directory for helpers specified inside the helpers array in your `jasmine.json` file.
Example:

Expand All @@ -122,7 +124,19 @@ beforeAll(() => {
});
```

That's it! You're good to go.
### With Karma and TypeScript in an Angular project
Copy link

@ghost ghost Dec 16, 2020 •
edited by ghost
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To match the title above this should be 'With TypeScript'.

Maybe add (eg. Angular)? nah, I think the difference is really the language...


Add to the existing `types` array in `tsconfig.spec.json`: `"@testing-library/jasmine-dom"`
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add "@testing-library/jasmine-dom" to types in the tests tsconfig (tsconfig.spec.json in an Angular project).

Example:

compilerOptions:
  types: ["jasmine", "node", "@testing-library/jasmine-dom"],.


In your tests setup file, import jasmine-dom like so:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In your tests setup file (test.ts in an Angular project), import jasmine-dom and add to the Jasmine matchers like so:


```typescript
import JasmineDOM from '@testing-library/jasmine-dom/dist';

beforeAll(() => {
jasmine.getEnv().addMatchers(JasmineDOM);
});
```

## Matchers

Expand Down