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

@sheetbase/storage

v3.0.2

Published

Sheetbase file management with Drive.

Downloads

2

Readme

@sheetbase/storage

Sheetbase file management with Drive.

  • Install: npm install --save @sheetbase/storage

  • Usage:

// 1. import module
import { StorageModule } from "@sheetbase/storage";

// 2. create an instance
export class App {
  // the object
  storageModule: StorageModule;

  // initiate the instance
  constructor() {
    this.storageModule = new StorageModule(/* options */);
  }
}

| Name | Type | Description | | -------------------------------------------------------------------------------------------- | --------------------------------------- | ----------- | | allowTypes? | string[] | | | maxSize? | undefined | number | | | nested? | undefined | false | true | | | uploadFolder | string | | | urlBuilder? | string[] | function | |

The Lib class.

| Name | Type | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ----------- | | helperService | HelperService | | | optionService | OptionService | | | storageRoute | StorageRoute | | | storageService | StorageService | |

| Function | Returns type | Description | | --------------------------------------------------------------------- | ---------------------------- | ------------------------ | | registerRoutes(routeEnabling?, middlewares?) | RouterService<> | Expose the module routes |

Expose the module routes

Parameters

| Param | Type | Description | | ------------- | -------------------------------------------- | ----------- | | routeEnabling | true | DisabledRoutes | | | middlewares | Middlewares | RouteMiddlewares | |

Returns

RouterService<>


StorageModule provides REST API endpoints allowing clients to access server resources. Theses enpoints are not exposed by default, to expose the endpoints:

StorageModule.registerRoutes(routeEnabling?);

StorageModule returns these routing errors, you may use the error code to customize the message:

  • storage/invalid-size: The file is too big.
  • storage/invalid-type: The file format is not supported.
  • storage/invalid-upload: Invalid upload resource.
  • storage/no-edit: No EDIT permission.
  • storage/no-file: File not found (no VIEW permission or trashed).

| Route | Method | Disabled | Description | | ---------------------------- | -------- | -------- | ------------------------------ | | /storage | DELETE | true | delete a file | | /storage | GET | | Get file information | | /storage | POST | true | update a file | | /storage | PUT | true | upload a file / multiple files |

DISABLED delete a file

Request body

| Name | Type | Description | | ------ | ---------- | ----------- | | id | string | |

Middleware data

| Name | Type | Description | | -------- | ------------ | ----------- | | auth | AuthData | |

Response

void


Get file information

Request query

| Name | Type | Description | | ------ | ---------- | ----------- | | id | string | |

Middleware data

| Name | Type | Description | | ----- | ------------ | ----------- | | auth? | AuthData | |

Response

FileInfo


DISABLED update a file

Request body

| Name | Type | Description | | ---------- | ------------------ | ----------- | | id | string | | | update | FileUpdateData | |

Middleware data

| Name | Type | Description | | -------- | ------------ | ----------- | | auth | AuthData | |

Response

void


DISABLED upload a file / multiple files

Request body

| Name | Type | Description | | ------- | -------------------- | ----------- | | file? | UploadFile | | | folder? | string | | | rename? | RenamePolicy | | | share? | FileSharing | | | files? | UploadResource[] | |

Middleware data

| Name | Type | Description | | ----- | ------------ | ----------- | | auth? | AuthData | |

Response

FileInfo | FileInfo[]


License

@sheetbase/storage is released under the MIT license.