@nestbolt/excel
Installation
Install @nestbolt/excel and its peer dependencies in your NestJS project.
Install the Package
Install @nestbolt/excel with your preferred package manager:
npm install @nestbolt/excelyarn add @nestbolt/excelpnpm add @nestbolt/excelPeer Dependencies
The package requires the following peer dependencies. If you are working in an existing NestJS project, you likely already have all of them installed:
| Package | Version |
|---|---|
@nestjs/common | ^10.0.0 || ^11.0.0 |
@nestjs/core | ^10.0.0 || ^11.0.0 |
reflect-metadata | ^0.1.13 || ^0.2.0 |
If any are missing, install them:
npm install @nestjs/common @nestjs/core reflect-metadataOptional Dependencies
class-validator and class-transformer
If you plan to use DTO-based validation during imports (the { dto: UserDto } form of WithValidation.rules()), you need class-validator and class-transformer:
npm install class-validator class-transformerThese packages are entirely optional. Custom validation rules (using inline validate functions) work without them.
Storage Driver SDKs
If you plan to store exports to, or import files from, cloud storage, install the SDK for the driver you need:
| Driver | Package | Install Command |
|---|---|---|
| S3 | @aws-sdk/client-s3 | npm install @aws-sdk/client-s3 |
| GCS | @google-cloud/storage | npm install @google-cloud/storage |
| Azure | @azure/storage-blob | npm install @azure/storage-blob |
The local storage driver requires no additional packages and works out of the box.
Verify the Installation
After installing, you should be able to import the module and service in your application code:
import { ExcelModule, ExcelService } from "@nestbolt/excel";Head over to Quick Start to set up your first export.