# ngx-fs

> Access FS API from Electron through Angular Service

Latest version **0.0.1** (published 2017-06-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install ngx-fs
pnpm add ngx-fs
yarn add ngx-fs
bun add ngx-fs
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2017-06-28 |
| First published | 2017-06-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Aaron Czichon |
| Maintainers | aaronczichon |
| Keywords | angular, angular 2, electron, github-electron, fs, node |

## Links

- npm: https://www.npmjs.com/package/ngx-fs
- Repository: https://github.com/inoverse/ngx-fs
- Homepage: https://github.com/inoverse/ngx-fs#readme
- Issues: https://github.com/inoverse/ngx-fs/issues
- npm.io page: https://npm.io/package/ngx-fs

## Dependencies (1)

- [@types/electron](https://npm.io/package/@types/electron.md) ^1.4.38

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 0.0.1 (latest) — 2017-06-28

## README

# ngx-fs

Based on the `ngx-electron` package this wraps the fs node API for Angular applications which are running inside an electron app

## Installation

`ngx-fs` can be installed easily using either `yarn` or `npm` commands in the scope of an angular project.

```
$ yarn add ngx-fs --save
# or
$ npm install ngx-fs --save
```

`ngx-fs` is exposing a module called `NgxFsModule` which needs to be imported in your `AppModule`.

``` typescript
import {NgModule} from '@angular/core';
import {BrowserModule} from '@angular/platform-browser';
import {NgxFsModule} from 'ngx-fs';
import {AppComponent} from './app.component';
 
@NgModule({
    declarations: [],
    imports: [
      BrowserModule,
      NgxFsModule
    ],
    bootstrap: [AppComponent]
})
export class AppModule {
 
}
```

Once the module has been imported, you can easily use angular DI to ask for `FsService`.

``` typescript
import {Component} from '@angular/core';
import {FsService} from 'ngx-fs';
 
@Component({
  selector: 'my-app',
  templateUrl: 'app.html'
})
export class AppComponent {
 
    constructor(private _fsService: FsService) { }
}
```

---
_Source: https://npm.io/package/ngx-fs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._