StorageClient

@human-protocol/sdk / Modules / storage / StorageClient

Class: StorageClient

storage.StorageClient

Deprecated

StorageClient is deprecated. Use Minio.Client directly.

Introduction

This client enables to interact with S3 cloud storage services like Amazon S3 Bucket, Google Cloud Storage and others.

The instance creation of StorageClient should be made using its constructor:

constructor(params: StorageParams, credentials?: StorageCredentials)

If credentials is not provided, it uses an anonymous access to the bucket for downloading files.

Installation

npm

npm install @human-protocol/sdk

yarn

yarn install @human-protocol/sdk

Code example

import { StorageClient, StorageCredentials, StorageParams } from '@human-protocol/sdk';

const credentials: StorageCredentials = {
  accessKey: 'ACCESS_KEY',
  secretKey: 'SECRET_KEY',
};
const params: StorageParams = {
  endPoint: 'http://localhost',
  port: 9000,
  useSSL: false,
  region: 'us-east-1'
};

const storageClient = new StorageClient(params, credentials);

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new StorageClient(params, credentials?): StorageClient

Storage client constructor

Parameters

NameTypeDescription

params

StorageParams

Cloud storage params

credentials?

StorageCredentials

Optional. Cloud storage access data. If credentials is not provided - use an anonymous access to the bucket

Returns

StorageClient

Defined in

<<<<<<< HEAD storage.ts:73

storage.ts:73

develop

Properties

client

Private client: Client

Defined in

<<<<<<< HEAD storage.ts:64

storage.ts:64

develop


clientParams

Private clientParams: StorageParams

Defined in

<<<<<<< HEAD storage.ts:65

storage.ts:65

develop

Methods

bucketExists

bucketExists(bucket): Promise<boolean>

This function checks if a bucket exists.

Parameters

NameTypeDescription

bucket

string

Bucket name.

Returns

Promise<boolean>

Returns true if exists, false if it doesn't.

Code example

import { StorageClient, StorageCredentials, StorageParams } from '@human-protocol/sdk';

const credentials: StorageCredentials = {
  accessKey: 'ACCESS_KEY',
  secretKey: 'SECRET_KEY',
};
const params: StorageParams = {
  endPoint: 'http://localhost',
  port: 9000,
  useSSL: false,
  region: 'us-east-1'
};

const storageClient = new StorageClient(params, credentials);
const exists = await storageClient.bucketExists('bucket-name');

Defined in

<<<<<<< HEAD storage.ts:266

storage.ts:266

develop


downloadFiles

downloadFiles(keys, bucket): Promise<any[]>

This function downloads files from a bucket.

Parameters

NameTypeDescription

keys

string[]

Array of filenames to download.

bucket

string

Bucket name.

Returns

Promise<any[]>

Returns an array of json files downloaded and parsed into objects.

Code example

import { StorageClient, StorageCredentials, StorageParams } from '@human-protocol/sdk';

const params: StorageParams = {
  endPoint: 'http://localhost',
  port: 9000,
  useSSL: false,
  region: 'us-east-1'
};

const storageClient = new StorageClient(params);

const keys = ['file1.json', 'file2.json'];
const files = await storageClient.downloadFiles(keys, 'bucket-name');

Defined in

<<<<<<< HEAD storage.ts:113

storage.ts:113

develop


listObjects

listObjects(bucket): Promise<string[]>

This function list all file names contained in the bucket.

Parameters

NameTypeDescription

bucket

string

Bucket name.

Returns

Promise<string[]>

Returns the list of file names contained in the bucket.

Code example

import { StorageClient, StorageCredentials, StorageParams } from '@human-protocol/sdk';

const credentials: StorageCredentials = {
  accessKey: 'ACCESS_KEY',
  secretKey: 'SECRET_KEY',
};
const params: StorageParams = {
  endPoint: 'http://localhost',
  port: 9000,
  useSSL: false,
  region: 'us-east-1'
};

const storageClient = new StorageClient(params, credentials);
const fileNames = await storageClient.listObjects('bucket-name');

Defined in

<<<<<<< HEAD storage.ts:297

storage.ts:297

develop


uploadFiles

uploadFiles(files, bucket): Promise<UploadFile[]>

This function uploads files to a bucket.

Parameters

NameTypeDescription

files

any[]

Array of objects to upload serialized into json.

bucket

string

Bucket name.

Returns

Promise<UploadFile[]>

Returns an array of json files downloaded and parsed into objects.

Code example

import { StorageClient, StorageCredentials, StorageParams } from '@human-protocol/sdk';

const credentials: StorageCredentials = {
  accessKey: 'ACCESS_KEY',
  secretKey: 'SECRET_KEY',
};
const params: StorageParams = {
  endPoint: 'http://localhost',
  port: 9000,
  useSSL: false,
  region: 'us-east-1'
};

const storageClient = new StorageClient(params, credentials);
const file1 = { name: 'file1', description: 'description of file1' };
const file2 = { name: 'file2', description: 'description of file2' };
const files = [file1, file2];
const uploadedFiles = await storageClient.uploadFiles(files, 'bucket-name');

Defined in

<<<<<<< HEAD storage.ts:201

storage.ts:201

develop


downloadFileFromUrl

downloadFileFromUrl(url): Promise<any>

This function downloads files from a Url.

Parameters

NameTypeDescription

url

string

Url of the file to download.

Returns

Promise<any>

Returns the JSON file downloaded and parsed into object.

Code example

import { StorageClient } from '@human-protocol/sdk';

const file = await storageClient.downloadFileFromUrl('http://localhost/file.json');

Defined in

<<<<<<< HEAD storage.ts:148

storage.ts:148

develop

Last updated