Skip to content

Commit 3c99909

Browse files
committed
docs: content for 3.8.5
1 parent f47ff67 commit 3c99909

29 files changed

Lines changed: 367 additions & 5 deletions
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: $copyFile
3+
description: Copies a file from one location to another.
4+
---
5+
6+
Copies a file from one location to another.
7+
## Parameters
8+
| Name | Description | Enforced | Default Value |
9+
|-------------|----------------------------|----------|---------------|
10+
| Source | The source file path. | Yes | None |
11+
| Destination | The destination file path. | Yes | None |
12+
## Example
13+
```eats
14+
$copyFile[source;destination]
15+
```
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: $cpuArch
3+
description: Returns the architecture of the CPU.
4+
---
5+
6+
Returns the architecture of the CPU.
7+
## Example
8+
```eats
9+
$cpuArch
10+
```
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: $cpuCores
3+
description: Returns the amount of cores the CPU has.
4+
---
5+
6+
Returns the amount of cores the CPU has.
7+
## Example
8+
```eats
9+
$cpuCores
10+
```
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: $cpuModel
3+
description: Returns the model of the CPU.
4+
---
5+
6+
Returns the model of the CPU.
7+
## Example
8+
```eats
9+
$cpuModel
10+
```
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: $cpuSpeed
3+
description: Returns the speed of the CPU in MHz.
4+
---
5+
6+
Returns the speed of the CPU in MHz.
7+
## Example
8+
```eats
9+
$cpuSpeed
10+
```
Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: $cpu
2+
title: $cpuUsage
33
description: Returns how many CPU is being used by the process.
44
---
55

@@ -10,5 +10,7 @@ Returns how many CPU is being used by the process.
1010
| Decimals | How many decimals to be attached to the return number. | No | 2 |
1111
## Example
1212
```eats
13-
$cpu[decimals?]
14-
```
13+
$cpuUsage[decimals?]
14+
```
15+
## Function Aliases
16+
- $cpu
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: $createSymlink
3+
description: Creates a symbolic link to the source path.
4+
---
5+
6+
Creates a symbolic link to the source path.
7+
## Parameters
8+
| Name | Description | Enforced | Default Value |
9+
|-------------|----------------------------------------------------|----------|---------------|
10+
| Source Path | The path of the file to create a symbolic link to. | Yes | None |
11+
| Link Path | The path of the file to link. | Yes | None |
12+
## Example
13+
```eats
14+
$createSymlink[sourcePath;linkPath]
15+
```
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: $createTempFolder
3+
description: Creates a temporary folder in the temp directory.
4+
---
5+
6+
Creates a temporary folder in the temp directory.
7+
## Parameters
8+
| Name | Description | Enforced | Default Value |
9+
|------|-----------------------------------|----------|---------------|
10+
| Name | The name of the temporary folder. | Yes | None |
11+
## Example
12+
```eats
13+
$createTempFolder[name]
14+
```
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: $fileAccessedAt
3+
description: Returns the time when the file was last accessed.
4+
---
5+
6+
Returns the time when the file was last accessed.
7+
## Parameters
8+
| Name | Description | Enforced | Default Value |
9+
|-----------|-----------------------|----------|---------------|
10+
| File Path | The path to the file. | Yes | None |
11+
## Example
12+
```eats
13+
$fileAccessedAt[filePath]
14+
```
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: $fileBlockCount
3+
description: Returns the block count of the file or directory.
4+
---
5+
6+
Returns the block count of the file or directory.
7+
## Parameters
8+
| Name | Description | Enforced | Default Value |
9+
|-----------|------------------------------------|----------|---------------|
10+
| File Path | The path to the file or directory. | Yes | None |
11+
## Example
12+
```eats
13+
$fileBlockCount[filePath]
14+
```

0 commit comments

Comments
 (0)