Skip to content
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.

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

Add: documentation for Programmatic api #2

Merged
merged 1 commit into from
Aug 11, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
File renamed without changes.
12 changes: 12 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Nightwatch Chrome Recorder

[![Build](https://github.com/vaibhavsingh97/nightwatch-chrome-recorder/actions/workflows/build.yml/badge.svg)](https://github.com/vaibhavsingh97/nightwatch-chrome-recorder/actions/workflows/build.yml)
[![npm][npm-badge]][npm]
[![Discord][discord-badge]][discord]

This repo provide tools to export Nightwatch test from Google Chrome Devtools Recordings

Expand Down Expand Up @@ -90,6 +92,11 @@ console.log(stringifiedContent);
// });
```

## 📝 Documentation

You can find about more about Programmatic API [here](docs/README.md)


## 🐛 Issues

Issues with this schematic can filed [here](https://github.com/nightwatchjs/nightwatch-chrome-recorder/issues)
Expand Down Expand Up @@ -150,3 +157,8 @@ We only support following steps:
10. `waitForElement`

If the step type is not mentioned above, a warning will be shown.

[npm-badge]: https://img.shields.io/npm/v/@nightwatch/chrome-recorder.svg
[npm]: https://www.npmjs.com/package/@nightwatch/chrome-recorder
[discord-badge]: https://img.shields.io/discord/618399631038218240.svg?color=7389D8&labelColor=6A7EC2&logo=discord&logoColor=ffffff&style=flat-square
[discord]: https://discord.gg/SN8Da2X
1 change: 1 addition & 0 deletions docs/.nojekyll
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
71 changes: 71 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
@nightwatch/chrome-recorder

# @nightwatch/chrome-recorder

## Table of contents

### Functions

- [nightwatchStringifyChromeRecording](README.md#nightwatchstringifychromerecording)
- [parseRecordingContent](README.md#parserecordingcontent)
- [transformParsedRecording](README.md#transformparsedrecording)

## Functions

### nightwatchStringifyChromeRecording

▸ **nightwatchStringifyChromeRecording**(`recording`): `Promise`<`Promise`<`string`\> \| `undefined`\>

#### Parameters

| Name | Type |
| :---------- | :------- |
| `recording` | `string` |

#### Returns

`Promise`<`Promise`<`string`\> \| `undefined`\>

#### Defined in

[main.ts:18](https://github.com/vaibhavsingh97/nightwatch-chrome-recorder/blob/main/src/main.ts#L18)

---

### parseRecordingContent

▸ **parseRecordingContent**(`recordingContent`): `Schema.UserFlow`

#### Parameters

| Name | Type |
| :----------------- | :------- |
| `recordingContent` | `string` |

#### Returns

`Schema.UserFlow`

#### Defined in

[main.ts:4](https://github.com/vaibhavsingh97/nightwatch-chrome-recorder/blob/main/src/main.ts#L4)

---

### transformParsedRecording

▸ **transformParsedRecording**(`parsedRecording`): `Promise`<`string`\>

#### Parameters

| Name | Type |
| :---------------- | :--------- |
| `parsedRecording` | `UserFlow` |

#### Returns

`Promise`<`string`\>

#### Defined in

[main.ts:10](https://github.com/vaibhavsingh97/nightwatch-chrome-recorder/blob/main/src/main.ts#L10)
Loading