Home Reference Source
import FilesUtil from 'chris-utils'
public class | source

FilesUtil

An instance of this class represents Files utility service

Static Method Summary

Static Public Methods
public static

createService(chrisClient: Client): FilesUtil

Create a service object of this class

Constructor Summary

Public Constructor
public

constructor(chrisClient: Client)

Constructor

Member Summary

Public Members
public

Method Summary

Public Methods
public

async downloadFiles(pluginInstance: Object)

Download files of a given plugin instance

public

async downloadZip(pfdoInst: Object, zipName: String)

Download a zip file of a given pfdorun instance

public

async uploadFiles(files: Array): Promise<String>

Upload files to CUBE

Private Methods
private

_download(url: String): *

Private method to download a blob/file/stream from CUBE

Static Public Methods

public static createService(chrisClient: Client): FilesUtil source

Create a service object of this class

Params:

NameTypeAttributeDescription
chrisClient Client

A Chris Client object

Return:

FilesUtil

An instance of this class

Public Constructors

public constructor(chrisClient: Client) source

Constructor

Params:

NameTypeAttributeDescription
chrisClient Client

A Chris Client Object

Public Members

public chrisClient: * source

Public Methods

public async downloadFiles(pluginInstance: Object) source

Download files of a given plugin instance

Params:

NameTypeAttributeDescription
pluginInstance Object

public async downloadZip(pfdoInst: Object, zipName: String) source

Download a zip file of a given pfdorun instance

Params:

NameTypeAttributeDescription
pfdoInst Object

Id of a particular feed in CUBE

zipName String

Id of a particular feed in CUBE

public async uploadFiles(files: Array): Promise<String> source

Upload files to CUBE

Params:

NameTypeAttributeDescription
files Array

An array of files object

Return:

Promise<String>

JS Promise, resolves to a string value

Private Methods

private _download(url: String): * source

Private method to download a blob/file/stream from CUBE

Params:

NameTypeAttributeDescription
url String

API endpoint to a particular resource in CUBE

Return:

*