Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

fimidara

softkave102MIT1.36.0TypeScript support: included

js sdk for fimidara file storage service

fimidara, file storage, file access control

readme

fimidara

JavaScript SDK for fimidara.com, a file storage service. See docs at https://www.fimidara.com/docs/fimidara-js-sdk.

Installation

  • npm install fimidara
  • yarn add fimidara

Usage

// import fimidara
import * as fimidara from 'fimidara';

// setup
const fimidaraEndpoints = new fimidara.FimidaraEndpoints({
  authToken: '<your auth token>',
});

// change auth token
fimidara.setConfig({authToken: '<new auth token>'});

// perform operations
const file = fimidara.file.readFile({
  filepath: 'workspace-rootname/folder/path/to/file.png',
});

// display file
<img
  src={fimidara.getFimidaraReadFileURL({
    filepath: 'workspace-rootname/folder/path/to/file.png',
  })}
/>;

// get upload file URL for form uploads
const uploadFileURL = fimidara.getFimidaraUploadFileURL({
  filepath: 'workspace-rootname/folder/path/to/file.png',
});