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

@universal-packages/express-controllers-storage

v1.4.14

Published

universal-storage implementation on top of universal-express-controllers.

Downloads

767

Readme

Express Controllers Storage

npm version Testing codecov

universal-storage implementation on top of universal-express-controllers

Install

npm install @universal-packages/express-controllers-storage

npm install @universal-packages/express-controllers

Global methods

initialize(options: Object, [authenticatableClass: AuthenticatableClass])

Initialize the storage api and the storage controller to prepare routing configuration before the ExpressControllers runs. The storage controller is loaded automatically by ExpressControllers.

import { initialize } from '@universal-packages/express-controllers-storage'
import { ExpressControllers } from '@universal-packages/express-controllers'
import User from './User'

await initialize({ dynamicsLocation: './src' }, User)

const app = new ExpressControllers({ port: 3000 })
await app.prepare()
await app.run()

Now storage blobs a re being served in storage/:key/:filename

Options

initialize() takes the same options as Storage.

Additionally takes the following ones:

  • rootPath String default: /storage You can set the root of all storage routes, ex: /files
  • urlHost String default: 'http://localhost' You can set the host to generate urls for the controller actions url generators.
  • routes
    • retrieve
      • enable Boolean default: true Enables the controller to expose this action
      • path String default: /:key/:filename Enables the customization of the route for this action
      • method HTTPVerb default: GET Lets customize the method to access this action
  • debug Boolean default: false Enables the debug mode for the dynamics.
  • dynamicsLocation String The location of the dynamics.
  • externalStrategy redirect | proxy default: redirect The strategy to use for external urls generated by Storage, redirect to the service or proxy the data stream.

getKeyUrl(key: string, filename: string)

Returns the url for the retrieve action of the storage controller to access the given key. Based on urlHost, rootPath, retrieve route options.

getKeyVersionUrl(key: string, filename: string, descriptor: Object)

  • descriptor VersionBlobDescriptor
    • width Number
    • height Number
    • fit contain | cover | fill | inside | outside

Returns the url for the retrieve action of the storage controller to access the given key and version. Based on urlHost, rootPath, retrieve route options.

Dynamics

If you need to allow blobs depending on different conditions, you can override dynamic should-allow-access-blob and return true or false depending on your conditions.

import { Dynamic } from '@universal-packages/dynamic-api'

@Dynamic('should-allow-access-blob')
export default class ShouldAllowAccessBlobDynamic {
  async perform(payload): Promise<boolean> {
    const { request, key } = payload
    const currentUser = request.currentUser

    if (currentUser.canAccess(key)) {
      return true
    }

    return false
  }
}

Typescript

This library is developed in TypeScript and shipped fully typed.

Contributing

The development of this library happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving this library.

License

MIT licensed.