Sheetbase file management with Drive.

• Installation
• Options
• Lib
  • Lib properties
  • Lib methods
    • registerRoutes(routeEnabling?, middlewares?)
• Routing
  • Errors
  • Routes
    • Routes overview
    • Routes detail
      • DELETE /storage
      • GET /storage
      • POST /storage
      • PUT /storage
• Detail API reference

Installation

• 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 */);
  }
}

Options

Lib

The Lib class.

Lib properties

Lib methods

registerRoutes(routeEnabling?, middlewares?)

Expose the module routes

Parameters

Returns

RouterService<>

Routing

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?);

Errors

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).

Routes

Routes overview

Routes detail

DELETE /storage

DISABLED delete a file

Request body

Middleware data

Response

void

GET /storage

Get file information

Request query

Middleware data

Response

FileInfo

POST /storage

DISABLED update a file

Request body

Middleware data

Response

void

PUT /storage

DISABLED upload a file / multiple files

Request body

Middleware data

Response

FileInfo | FileInfo[]

@sheetbase/storage is released under the MIT license.