# nest-microservices-storage

> A NestJS module for generator-nest-microservices yeoman template to handle Azure storage features

Latest version **0.0.1** (published 2020-11-28) · UNLICENSED license · 0 weekly downloads

## Install

```sh
npm install nest-microservices-storage
pnpm add nest-microservices-storage
yarn add nest-microservices-storage
bun add nest-microservices-storage
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2020-11-28 |
| First published | 2020-11-28 |
| Weekly downloads | 0 |
| License | UNLICENSED |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 13 |
| Unpacked size | 7.9 KB |
| Known vulnerabilities | 0 (+4 in 3 direct dependencies) |
| Install scripts | yes |
| Author | Jason Magpantay |
| Maintainers | jsnmgpnty |

## Links

- npm: https://www.npmjs.com/package/nest-microservices-storage
- npm.io page: https://npm.io/package/nest-microservices-storage

## Dependencies (13)

- [rxjs](https://npm.io/package/rxjs.md) ^6.5.4
- [dotenv](https://npm.io/package/dotenv.md) ^8.2.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.20
- [rimraf](https://npm.io/package/rimraf.md) ^3.0.2
- [amqplib](https://npm.io/package/amqplib.md) ^0.6.0
- [@nestjs/core](https://npm.io/package/@nestjs/core.md) ^7.5.2
- [@nestjs/common](https://npm.io/package/@nestjs/common.md) ^7.5.2
- [@nestjs/config](https://npm.io/package/@nestjs/config.md) ^0.5.0
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.13
- [@azure/storage-blob](https://npm.io/package/@azure/storage-blob.md) ^12.2.0-preview.1
- [@nestjs/microservices](https://npm.io/package/@nestjs/microservices.md) ^7.5.2
- [amqp-connection-manager](https://npm.io/package/amqp-connection-manager.md) ^3.2.0
- [nest-microservices-logger](https://npm.io/package/nest-microservices-logger.md) 0.0.1

## Recent versions

- 0.0.1 (latest) — 2020-11-28

## README

# nest-microservices-storage
- A NestJS module for `generator-nest-microservices` yeoman template for redis features
### How to use
- install package with `npm i -S nest-microservices-storage`
- Register the `StorageModule` to your feature modules:
```
@Module({})
export class AppModule {
  static register(config: ConfigOptions): DynamicModule {
    return {
      module: AppModule,
      imports: [
        StorageModule.register(config.storageOptions),
        ...
      ],
    };
  }
}
```
- Once `RedisModule` is registered, then you can use `StorageService` to upload files to Azure Storage
```
export class ExampleController {
  constructor (private service: StorageService) {
    super (service);
  }

  @Post('upload')
  @UseInterceptors(FileInterceptor('file'))
  async upload(@UploadedFile() file: any): Promise<string> {
    const url = await this.service.uploadFile(file, 'container-name', 'custom/path/here');
    return url;
  }
}
```
### Storage options
|Property|Type|Required|Description|
|-|-|-|-|
|connectionString|`String`|true| Connection string for your Azure Storage
|accessKey|`String`|true| Access key for your Azure Storage
|accountName|`String`|true| Account name of your Azure Storage
|containerName|`String`|true| Default container to upload files to

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