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

@amplication/plugin-storage-local

v0.0.2

Published

Adds the local storage functionality for file upload to Amplication

Downloads

25,816

Readme

@amplication/plugin-storage-local

NPM Downloads

Purpose

This plugin is used for integrating local storage services into your app generated by Amplication.

Configuration

The plugin has the following configuration options:

  • fileBasePath: The base path where the files will be stored. The default value is ./uploads.
  • maxFileSize: The maximum file size in bytes. The default value is 10485760 (10MB).

Example configuration:

{
  "fileBasePath": "./uploads",
  "maxFileSize": 10485760
}

[!CAUTION] The storage-core plugin should be added through the plugins page of the app settings before adding this plugin. Else code generation will fail and throw an error.

What the plugin does

Adds service methods

It adds the following service methods for each field of type File in the entities:

  • upload: This method takes a file and uses the following name schmea to store the file: <fieldName>-<entityId>-<fileName>. ( eg: profileImage-1-image.png )

  • delete

  • download

Provides the local storage methods

  • uploadFile: This method is used to upload a file to the local storage. It takes the following parameters:

    • file: The file to be uploaded.
    • extension: The file mimeypes allowed for the file.
    • basePath: The base path where the file will be stored. If not provided, the default value from the configuration will be used.
    • maxFileSize: The maximum file size in bytes. If not provided, the default value from the configuration will be used.
  • deleteFile: This method is used to delete a file from the local storage.

  • downloadFile: This method is used to download a file from the local storage.

[!CAUTION] In case of extensions being empty, no file will be uploaded and an error will be thrown.

Scripts

build

Running npm run build will bundle your plugin with Webpack for production.

dev

Running npm run dev will watch your plugin's source code and automatically bundle it with every change.