codeceptjs
Version:
Modern Era Acceptance Testing Framework for NodeJS
87 lines (51 loc) • 1.47 kB
Markdown
---
id: FileSystem
title: FileSystem
---
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
## FileSystem
**Extends Helper**
Helper for testing filesystem.
Can be easily used to check file structures:
```js
I.amInPath('test');
I.seeFile('codecept.json');
I.seeInThisFile('FileSystem');
I.dontSeeInThisFile("WebDriverIO");
```
## Methods
### amInPath
Enters a directory In local filesystem.
Starts from a current directory
#### Parameters
- `openPath` **[string][1]**
### dontSeeFileContentsEqual
Checks that contents of file found by `seeFile` doesn't equal to text.
#### Parameters
- `text` **[string][1]**
- `encoding` **[string][1]**
### dontSeeInThisFile
Checks that file found by `seeFile` doesn't include text.
#### Parameters
- `text` **[string][1]**
- `encoding` **[string][1]**
### seeFile
Checks that file exists
#### Parameters
- `name` **[string][1]**
### seeFileContentsEqual
Checks that contents of file found by `seeFile` equal to text.
#### Parameters
- `text` **[string][1]**
- `encoding` **[string][1]**
### seeInThisFile
Checks that file found by `seeFile` includes a text.
#### Parameters
- `text` **[string][1]**
- `encoding` **[string][1]**
### writeToFile
Writes test to file
#### Parameters
- `name` **[string][1]**
- `text` **[string][1]**
[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String