dstor-sdk-core-test
v0.0.9
Published
Dstor SDK that allows you to work with a global storage dStor
Downloads
13
Readme
Dstor SDK that allows you to work with a global storage dStor
Installation
Using npm:
$ npm install dstor-sdk-core
Once the package is installed, you can import the library using import
or require
approach.
Import for react:
import { Dstor } from 'dstor-sdk-core/react';
Import for node.js:
const { Dstor } = require('dstor-sdk-core/node');
Getting Started
First you need to specify Environment in the constructor:
new Dstor({ environment: string })
environment: "maindish" || "staging" || "production"
const { Dstor } = require('dstor-sdk-core/node');
const data = {
environment: "xxx" // "maindish" || "staging" || "production"
}
const dstor = new Dstor(data);
Dstor.authentication({ email: string, password: string } || { apiKey: string });
const { Dstor } = require('dstor-sdk-core/node');
const data = {
environment: "xxx" // "maindish" || "staging" || "production"
}
const dstor = new Dstor(data);
const credits = {
email: '[email protected]',
password: 'xxxxxxx'
}
const dstorAuthenticationWithEmailPassword = async () => {
try {
const result = await dstor.authentication(credits); // return: "Authentication successful!"
}catch (e) {
console.log(e.message)
}
}
const { Dstor } = require('dstor-sdk-core/node');
const data = {
environment: "xxx" // "maindish" || "staging" || "production"
}
const dstor = new Dstor(data);
const credits = {
apiKey: 'xxxxxxxxxxxxxxxx'
}
const dstorAuthenticationWithApiKey = async () => {
try {
const result = await dstor.authentication(credits); // return: "Authentication successful!"
}catch (e) {
console.log(e.message)
}
}
Dstor.apiBaseUrl
const { Dstor } = require('dstor-sdk-core/node');
const data = {
environment: "xxx" // "maindish" || "staging" || "production"
}
const dstor = new Dstor(data);
const baseUrl = dstor.apiBaseUrl // api.xxx.Dstor.cloud
Dstor.getFileInfo(hash: string)
hash: hash that belongs to the file on dStor
const { Dstor } = require('dstor-sdk-core/node');
const data = {
environment: "xxx" // "maindish" || "staging" || "production"
}
const dstor = new Dstor(data);
const hash = 'xxxxxxxxxxx'
const data = async () => {
try{
const fileInfo = await dstor.getFileInfo(hash); // [{file_name: ... , file_hash: ... , file_size: ... , ......}]
}catch (e) {
console.log(e.message)
}
}
Dstor.downloadFile({ path: string, hash: string })
path: the full path where to save the file on the device
hash: hash that belongs to the file on dStore
const { Dstor } = require('dstor-sdk-core/node');
const data = {
environment: "xxx" // "maindish" || "staging" || "production"
}
const dstor = new Dstor(data);
const data = {
path: 'xxxxxx',
hash: 'xxxxxxxxxxxxx'
}
const resultMessage = async () => {
try{
const result = await dstor.downloadFile(data); // return: Download finished: file_name
}catch (e) {
console.log(e.message)
}
}
Dstor.uploadFile(data: string | any[])
data: for node.js the full path of the file (or array of path). For React e.target.files (or array of files)
const { Dstor } = require('dstor-sdk-core/node');
const data = {
environment: "xxx" // "maindish" || "staging" || "production"
}
const dstor = new Dstor(data);
const resultUpload = async () => {
try{
const result = await dstor.uploadFile(['path', 'path', ...]); // return: Upload successfully!
}catch (e) {
console.log(e.message) // "The upload has not been completed. Please contact the administration!" , "Empty array or invalid data type!"
}
}