Rabaz Terminal
What is this?
This library is an abstraction for terminal-api usage.
It exposes certain functions to interact with the api
Install:
npm install --save rabaz-terminal
Usage:
Code
const { Terminal } = require('rabaz-terminal');
// or
import { Terminal } from 'rabaz-terminal';
const terminal = new Terminal('terminal_url', 'api_key');Class: Terminal
Options
-
TERMINAL_API_USE_BEARER: set to false to not use
'Bearer'keyword in Authorization header of api request - default:true -
TERMINAL_API_FOLDERS_ENDPOINT: the url endpoint for accessing the "folders" resource - default:
/folders -
TERMINAL_API_UPLOAD_ENDPOINT: the url endpoint for accessing the "upload" resource - default:
/upload -
TERMINAL_API_DOWNLOAD_ENDPOINT: the url endpoint for accessing the "download" resource - default:
/download -
TERMINAL_API_TEMP_FOLDER_PATH: the folder of temporary folders and files on upload - default:
../../tmp -
TERMINAL_API_TEMP_RESULTS_LIMIT: number of results from terminal - default:
1000 -
TERMINAL_API_SEND_POLLING_INTERVAL: frequency of checking terminal status in recieve and transfer functions - default:
1000 -
TERMINAL_API_TEMINAL_SEND_DELAY: timeout of recieve and transfer functions - default:
20 * 60 * 1000 -
TERMINAL_API_EXTENDED_FILE_STATUSES: extend statuses - default:
[] -
TERMINAL_API_DEPRICATED_FILE_STATUSES: reomve statuses - default:
[] -
TERMINAL_API_EXTENDED_NACK_REASONS: extend nack reasons - default:
[] -
TERMINAL_API_DEPRICATED_NACK_REASON: reomve nack reasons - default:
[] -
TERMINAL_API_DEFAULT_NACK_REASON: default terminal nack reason - default:
NACKED_BY_SERVICE -
TERMINAL_API_LIGHT_REQUEST_TIMEOUT: light terminal request timeout - default:
15 * 1000 -
TERMINAL_API_HEAVY_REQUEST_TIMEOUT: heavy terminal request timeout - default:
5 * 60 * 1000