npm package: @gauravachhani/file-electron
Description: Plugin helps you to use remote, fs and path modules for electron 10+
Author: Gaurav Vachhani
Latest version: 0.0.4

# @gauravachhani/file-electron

Plugin helps you to use remote, fs and path modules for electron 10+

## Install

```bash
npm install @gauravachhani/file-electron
npx cap sync
```

## API

<docgen-index>

* [`echo(...)`](#echo)
* [`userPath()`](#userpath)
* [`resolvePath(...)`](#resolvepath)
* [`joinPath(...)`](#joinpath)
* [`existsSync(...)`](#existssync)
* [`copyFile(...)`](#copyfile)
* [`_mkdirSyncRecursive(...)`](#_mkdirsyncrecursive)
* [`_copyRecursiveSync(...)`](#_copyrecursivesync)
* [`writeFile(...)`](#writefile)
* [`readFile(...)`](#readfile)
* [`moveFile(...)`](#movefile)
* [`removeFile(...)`](#removefile)
* [`renameFile(...)`](#renamefile)
* [`readdirSync(...)`](#readdirsync)

</docgen-index>

<docgen-api>
<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->

### echo(...)

```typescript
echo(options: { value: string; }) => Promise<{ value: string; }>
```

| Param         | Type                            |
| ------------- | ------------------------------- |
| **`options`** | <code>{ value: string; }</code> |

**Returns:** <code>Promise&lt;{ value: string; }&gt;</code>

--------------------


### userPath()

```typescript
userPath() => Promise<{ value: string; }>
```

**Returns:** <code>Promise&lt;{ value: string; }&gt;</code>

--------------------


### resolvePath(...)

```typescript
resolvePath(options?: { target: string; source: string; } | undefined) => Promise<any>
```

| Param         | Type                                             |
| ------------- | ------------------------------------------------ |
| **`options`** | <code>{ target: string; source: string; }</code> |

**Returns:** <code>Promise&lt;any&gt;</code>

--------------------


### joinPath(...)

```typescript
joinPath(options?: { target: string; source: string; } | undefined) => Promise<any>
```

| Param         | Type                                             |
| ------------- | ------------------------------------------------ |
| **`options`** | <code>{ target: string; source: string; }</code> |

**Returns:** <code>Promise&lt;any&gt;</code>

--------------------


### existsSync(...)

```typescript
existsSync(path: string) => Promise<any>
```

| Param      | Type                |
| ---------- | ------------------- |
| **`path`** | <code>string</code> |

**Returns:** <code>Promise&lt;any&gt;</code>

--------------------


### copyFile(...)

```typescript
copyFile(source: string, target: string) => Promise<any>
```

| Param        | Type                |
| ------------ | ------------------- |
| **`source`** | <code>string</code> |
| **`target`** | <code>string</code> |

**Returns:** <code>Promise&lt;any&gt;</code>

--------------------


### _mkdirSyncRecursive(...)

```typescript
_mkdirSyncRecursive(source: string) => Promise<any>
```

| Param        | Type                |
| ------------ | ------------------- |
| **`source`** | <code>string</code> |

**Returns:** <code>Promise&lt;any&gt;</code>

--------------------


### _copyRecursiveSync(...)

```typescript
_copyRecursiveSync(source: string, target: string) => Promise<any>
```

| Param        | Type                |
| ------------ | ------------------- |
| **`source`** | <code>string</code> |
| **`target`** | <code>string</code> |

**Returns:** <code>Promise&lt;any&gt;</code>

--------------------


### writeFile(...)

```typescript
writeFile(path: string, data: any, options: any) => Promise<any>
```

| Param         | Type                |
| ------------- | ------------------- |
| **`path`**    | <code>string</code> |
| **`data`**    | <code>any</code>    |
| **`options`** | <code>any</code>    |

**Returns:** <code>Promise&lt;any&gt;</code>

--------------------


### readFile(...)

```typescript
readFile(path: string, options: any) => Promise<any>
```

| Param         | Type                |
| ------------- | ------------------- |
| **`path`**    | <code>string</code> |
| **`options`** | <code>any</code>    |

**Returns:** <code>Promise&lt;any&gt;</code>

--------------------


### moveFile(...)

```typescript
moveFile(source: string, destination: string) => Promise<any>
```

| Param             | Type                |
| ----------------- | ------------------- |
| **`source`**      | <code>string</code> |
| **`destination`** | <code>string</code> |

**Returns:** <code>Promise&lt;any&gt;</code>

--------------------


### removeFile(...)

```typescript
removeFile(path: string) => Promise<any>
```

| Param      | Type                |
| ---------- | ------------------- |
| **`path`** | <code>string</code> |

**Returns:** <code>Promise&lt;any&gt;</code>

--------------------


### renameFile(...)

```typescript
renameFile(oldPath: string, oldName: string, newPath: string, newName: string) => Promise<any>
```

| Param         | Type                |
| ------------- | ------------------- |
| **`oldPath`** | <code>string</code> |
| **`oldName`** | <code>string</code> |
| **`newPath`** | <code>string</code> |
| **`newName`** | <code>string</code> |

**Returns:** <code>Promise&lt;any&gt;</code>

--------------------


### readdirSync(...)

```typescript
readdirSync(path: string) => Promise<any>
```

| Param      | Type                |
| ---------- | ------------------- |
| **`path`** | <code>string</code> |

**Returns:** <code>Promise&lt;any&gt;</code>

--------------------

</docgen-api>