nope-js-browser
Version:
NoPE Runtime for the Browser. For nodejs please use nope-js-node
81 lines (80 loc) • 1.99 kB
TypeScript
/**
* @author Martin Karkowski
* @email m.karkowski@zema.de
*/
import "reflect-metadata";
/**
* Helper Function to write a default configuration.
*/
export declare function writeUiFile(options?: {
dir: string;
filename: string;
}): Promise<void>;
/**
* Helper to extract the Arguments for the `writeUiFile` function @see writeUiFile
*
* @author M.Karkowski
* @export
* @param additionalArguments Arguments added by the nope.cli
* @return {*} The Arguments
*/
export declare function readInWriteUiFileArgs(additionalArguments?: {
help: string;
type: "string" | "number";
name: string | string;
defaultValue?: any;
}[]): {
dir: string;
filename: string;
};
export interface IDataElement {
name: string;
originalName: string;
path: string;
keywords: string;
identifier: string;
additionalOptions: any;
uuid: string;
type: string;
date: string;
}
export interface UploadArgs {
/**
* File containing the UI-Defintions
*/
file: string;
/**
* Default uri of the upload server
*/
uri: string;
/**
* The mode how to handle the ui-file.
*/
mode: "replace" | "merge";
}
export declare const DEFAULT_SETTINGS: UploadArgs;
/**
* Helper Function to Read-In the Arguments used by the
* cli-tool
*
* @return {*}
*/
export declare function readInArgs(additionalArguments?: {
help: string;
type: "string" | "number";
name: string | string;
defaultValue?: any;
}[], forcedArgs?: Partial<UploadArgs>): Promise<UploadArgs>;
export declare function uploadUi(args: Partial<UploadArgs>): Promise<void>;
/**
* Main Function.
*
* @export
*/
export declare function main(additionalArguments?: {
help: string;
type: "string" | "number";
name: string | string;
defaultValue?: any;
}[], forcedArgs?: Partial<UploadArgs>): Promise<void>;
export default uploadUi;