npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@eleven-am/nestjs-storage

v0.0.17

Published

A NestJS module for uploading files to cloud storage providers

Downloads

23

Readme

Nest Storage

Nest Storage is a module for Nest.js that simplifies interaction with various storage providers. It offers a flexible and extensible approach to handle storage operations in your Nest.js applications.

Installation

To use Nest Storage in your Nest.js application, install the package via npm:

npm install @eleven-am/nestjs-storage

Usage

1. Import StorageModule

import { StorageModule } from '@eleven-am/nestjs-storage';

@Module({
  imports: [
    StorageModule.forRoot({
      provider: Provider.LOCAL, // Choose your storage provider
      // Add provider-specific options as needed
    }),
  ],
})
export class YourModule {}

2. Inject and Use StorageService

import { Injectable } from '@nestjs/common';
import { StorageService } from 'nest-storage';

@Injectable()
export class YourService {
  constructor(private readonly storageService: StorageService) {}

  // Use storageService methods for file and folder operations
  // Example: this.storageService.putFile('path/to/file.txt', bufferData);
}

Supported Providers

  • Local Storage: Provider.LOCAL
  • Google Drive Storage: Provider.GDRIVE
  • Dropbox Storage: Provider.DROPBOX
  • Amazon S3 Storage: Provider.S3 and Provider.R2

Certainly! Here's the same API section with reduced font size for the function names:

API Reference: StorageService

putFile(path: string, data: Buffer): Promise<void>

Uploads a file to the storage provider at the specified path.

  • Parameters:
    • path (string): The destination path for the file.
    • data (Buffer): The data to be stored.

getFileOrFolder(fileId: string): Promise<any>

Retrieves information about a file or folder from the storage provider.

  • Parameters:
    • fileId (string): The identifier of the file or folder.

readFile(fileId: string): Promise<Buffer>

Reads the content of a file from the storage provider.

  • Parameters:
    • fileId (string): The identifier of the file.

deleteFileOrFolder(fileId: string): Promise<void>

Deletes a file or folder from the storage provider.

  • Parameters:
    • fileId (string): The identifier of the file or folder.

moveFileOrFolder(fileId: string, newPath: string): Promise<void>

Moves a file or folder to a new location within the storage provider.

  • Parameters:
    • fileId (string): The identifier of the file or folder.
    • newPath (string): The new path for the file or folder.

renameFileOrFolder(fileId: string, newName: string): Promise<void>

Renames a file or folder in the storage provider.

  • Parameters:
    • fileId (string): The identifier of the file or folder.
    • newName (string): The new name for the file or folder.

createFolder(path: string): Promise<void>

Creates a new folder in the storage provider.

  • Parameters:
    • path (string): The path for the new folder.

readFolder(folderId: string): Promise<any[]>

Reads the contents of a folder from the storage provider.

  • Parameters:
    • folderId (string): The identifier of the folder.

getProvider(): string

Returns the current storage provider name.

  • Returns:
    • (string): The name of the storage provider (LOCAL, GDRIVE, DROPBOX, S3, or R2).

Contributing

Contributions are welcome! If you find any issues or have suggestions, feel free to open an issue or create a pull request.

License

This project is licensed under the GPL 3.0 License.