Skip to content
This repository has been archived by the owner on Jul 29, 2024. It is now read-only.

Commit

Permalink
docs(exampleTypescript): improve comments and readme (#3406)
Browse files Browse the repository at this point in the history
  • Loading branch information
gkalpak authored and cnishina committed Jul 21, 2016
1 parent ee70e6e commit 55fe53a
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
6 changes: 3 additions & 3 deletions exampleTypescript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The ambient typings are downloaded from DefinitelyTyped in the `postinstall` ste

## Protractor typings

To use Protractor types, you'll need to import `protractor/globals`. After this is imported, you should have auto completition hints when typing.
To use Protractor types, you'll need to import `protractor/globals`. After this is imported, you should have autocompletion hints when typing.

```
import {browser, element, by, By, $, $$, ExpectedConditions} from 'protractor/globals';
Expand All @@ -66,12 +66,12 @@ export let config: Config = {

## Ambient typings

Protractor also uses ambient types including jasmine and node. These are brought in via the `typings.json` file. The ambient typings files are imported from the `typings/index.d.ts` generated file and are included in the project via the tsconfig.json configuration file.
Protractor also uses ambient types including jasmine and node. These are brought in via the `typings.json` file. The ambient typings files are imported from the `typings/index.d.ts` generated file and are included in the project via the `tsconfig.json` configuration file.


## Compiling your code

To convert your typescript to javascript (transpiling), you'll use the Typescript comipler (tsc). If you install typescript globally, the command is `tsc`. If it is not installed globally, the typescript compiler can be executed with `npm run tsc`.
To convert your typescript to javascript (transpiling), you'll use the Typescript compiler (tsc). If you install typescript globally, the command is `tsc`. If it is not installed globally, the typescript compiler can be executed with `npm run tsc`.

## Running Protractor

Expand Down
8 changes: 4 additions & 4 deletions exampleTypescript/conf.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
// information.
//
// Why you might want to create your config with typescript:
// edtiors like Microsoft Visual Studio Code will have autocomplete and
// Editors like Microsoft Visual Studio Code will have autocomplete and
// description hints.
//
// To run this example, run 'npm run tsc' to transpile the typescript to
// javascript. run with 'protractor conf.js'
// To run this example, first transpile it to javascript with `npm run tsc`,
// then run `protractor conf.js`.
import {Config} from 'protractor';

export let config: Config = {
export let config: Config = {
framework: 'jasmine',
capabilities: {
browserName: 'chrome'
Expand Down
8 changes: 4 additions & 4 deletions exampleTypescript/confPageObjects.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
// information.
//
// Why you might want to create your config with typescript:
// edtiors like Microsoft Visual Studio Code will have autocomplete and
// Editors like Microsoft Visual Studio Code will have autocomplete and
// description hints.
//
// To run this example, run 'npm run tsc' to transpile the typescript to
// javascript. run with 'protractor conf_withPageObjects.js'
// To run this example, first transpile it to javascript with `npm run tsc`,
// then run `protractor confPageObjects.js`.
import {Config} from 'protractor';

export let config: Config = {
export let config: Config = {
framework: 'jasmine',
capabilities: {
browserName: 'chrome'
Expand Down

0 comments on commit 55fe53a

Please sign in to comment.