/** * @author fenris */ type int = number; /** * @author fenris */ type float = number; declare var process: any; declare var require: any; declare class Buffer { constructor(x: string, modifier?: string); static from(x: string, encoding?: string): any; toString(modifier?: string): string; } declare namespace lib_plankton.base { /** * @author fenris */ function environment(): string; } /** * @author fenris */ type type_pseudopointer = { value: type_value; }; /** * @author fenris */ declare function pseudopointer_null(): type_pseudopointer; /** * @author fenris */ declare function pseudopointer_make(value: type_value): type_pseudopointer; /** * @author fenris */ declare function pseudopointer_isset(pseudopointer: type_pseudopointer): boolean; /** * @author fenris */ declare function pseudopointer_read(pseudopointer: type_pseudopointer): type_value; /** * @author fenris */ declare function pseudopointer_write(pseudopointer: type_pseudopointer, value: type_value): void; /** * @author fenris */ declare var instance_verbosity: int; /** * @desc the ability to check for equality with another element of the same domain * @author fenris */ interface interface_collatable { /** * @author fenris */ _collate(value: type_value): boolean; } /** * @author fenris */ declare function instance_collate(value1: (type_value & { _collate?: ((value: type_value) => boolean); }), value2: type_value): boolean; /** * @desc the ability to compare with another element of the same domain for determining if the first is "smaller than or equal to" the latter * @author fenris */ interface interface_comparable { /** * @author fenris */ _compare(value: type_value): boolean; } /** * @author fenris */ declare function instance_compare(value1: (type_value & { _compare: ((value: type_value) => boolean); }), value2: type_value): boolean; /** * @desc the ability to create an exact copy * @author fenris */ interface interface_cloneable { /** * @author fenris */ _clone(): type_value; } /** * @author fenris */ declare function instance_clone(value: (type_value & { _clone?: (() => type_value); })): type_value; /** * @author fenris */ interface interface_hashable { /** * @author fenris */ _hash(): string; } /** * @desc the ability to generate a string out of the element, which identifies it to a high degree * @author fenris */ declare function instance_hash(value: (type_value & { _hash?: (() => string); })): string; /** * @author fenris */ interface interface_showable { /** * @author fenris */ _show(): string; } /** * @desc the ability to map the element to a textual representation (most likely not injective) * @author fenris */ declare function instance_show(value: (type_value & { _show?: (() => string); })): string; /** * @author frac */ interface interface_decorator { /** * @author frac */ core: type_core; } /** * @author frac */ declare class class_observer { /** * @author frac */ protected counter: int; /** * @author frac */ protected actions: { [id: string]: (information: Object) => void; }; /** * @author frac */ protected buffer: Array; /** * @author frac */ constructor(); /** * @author frac */ empty(): boolean; /** * @author frac */ flush(): void; /** * @author frac */ set(id: string, action: (information: Object) => void): void; /** * @author frac */ del(id: string): void; /** * @author frac */ add(action: (information: Object) => void): void; /** * @author frac */ notify(information?: Object, delayed?: boolean): void; /** * @author frac */ rollout(): void; } /** * @author frac */ /** * @author frac */ /** * @author frac */ declare class class_error extends Error { /** * @author frac */ protected suberrors: Array; /** * @author frac */ protected mess: string; /** * @author frac */ constructor(message: string, suberrors?: Array); /** * @override * @author frac */ toString(): string; } declare namespace lib_plankton.base { /** * returns the current UNIX timestamp * * @author fenris */ function get_current_timestamp(rounded?: boolean): float; /** */ function object_merge(core: Record, mantle: Record): Record; /** */ function buffer_show(buffer: Buffer, { "block_size": option_block_size, "break_char": option_break_char, }?: { block_size?: int; break_char?: string; }): string; } declare module lib_plankton.pod { /** * @author fenris */ type type_pod = { kind: ("empty" | "filled"); value?: type_value; }; /** * @author fenris */ function make_empty(): type_pod; /** * @author fenris */ function make_filled(value: type_value): type_pod; /** * whether the pod is filled * * @author fenris */ function is_filled(pod: type_pod): boolean; /** * return the value, stored in the pod-wrapper * * @author fenris */ function cull(pod: type_pod): type_value; /** * to pass on a empty-pod or to use a filled-pod * * @author fenris */ function propagate(pod: type_pod, function_: ((value: type_value) => type_value_)): type_pod; /** * @author fenris */ function distinguish(pod: type_pod, function_empty: (() => type_result), function_filled: ((value: type_value) => type_result)): type_result; /** */ function show(pod: type_pod, options?: { show_value?: ((value: type_value) => string); }): string; } declare module lib_plankton.pod { /** */ class class_pod { private subject; constructor(subject: type_pod); tear(): type_pod; static empty(): class_pod; static filled(value: type_value): class_pod; is_empty(): boolean; is_filled(): boolean; cull(): type_value; show(show_value?: any): string; toString(): string; propagate(function_: ((value: type_value) => type_value_)): class_pod; distinguish(function_empty: (() => type_result), function_filled: ((value: type_value) => type_result)): type_result; } } /** * might be completely obsolete */ declare namespace lib_plankton.call { /** * @author fenris */ type type_promise = Promise; /** * @author fenris */ function promise_reject(reason: type_reason): type_promise; /** * @author fenris */ function promise_resolve(result: type_result): type_promise; /** * @author fenris */ function promise_make(executor: (resolve: ((result?: type_result) => void), reject: ((reason?: type_reason) => void)) => void): type_promise; /** * @author fenris */ function promise_then_close(promise: type_promise, resolver: ((result: type_result) => void), rejector: ((reason: type_reason) => void)): void; /** * @author fenris */ function promise_then_append(promise: type_promise, resolver: ((result: type_result) => type_promise), rejector?: ((reason: type_reason) => type_promise)): type_promise; /** * @author fenris */ function promise_all(promises: Array>): type_promise, type_reason>; /** * @author fenris */ function promise_chain(promises: (Array<(input: type_result) => type_promise>), start?: type_result): type_promise; /** * @author fenris */ function promise_condense(promises: Array<() => type_promise>): type_promise, type_reason>; /** * @author fenris */ function promise_group(promises: Record type_promise)>, options?: { serial?: boolean; }): type_promise, type_reason>; /** * @author fenris */ function promise_wrap(promise: type_promise, transformator_result: ((reason: type_result_inner) => type_result_outer), transformator_reason?: ((reason: type_reason) => type_reason)): type_promise; /** * @author fenris */ /** * @author fenris */ /** * @author fenris */ function promise_attach(state: Record, promise: type_promise, name: string): type_promise, type_reason>; /** * @author fenris */ function promise_delay(promise: type_promise, delay: int): type_promise; } /** * initializer might be obsolete, since promises are reusable after having been resolved or rejected */ declare namespace lib_plankton.call { /** * @author fenris */ enum enum_initializer_state { initial = 0, waiting = 1, successful = 2, failed = 3 } /** * @author fenris */ type type_initializer = { fetcher: (() => type_promise); state?: enum_initializer_state; queue: Array<{ resolve: ((result?: type_result) => void); reject: ((reason?: type_reason) => void); }>; result?: type_result; reason?: type_reason; }; /** * @author fenris */ function initializer_make(fetcher: (() => type_promise)): type_initializer; /** * @author fenris */ function initializer_reset(subject: type_initializer): void; /** * @author fenris */ function initializer_state(subject: type_initializer): enum_initializer_state; /** * @author fenris */ function initializer_get(subject: type_initializer): type_promise; } declare namespace lib_plankton.call { /** * @author fenris */ type type_deferral = { representation: (input: type_input) => Promise; }; /** * @author fenris * @desc activates the deferral and handles its output according to a given procedure * @param {(value : type_value)=>void} procedure a function which receives the output of the deferral as argument */ function deferral_use(deferral: type_deferral, input: type_input, procedure: (output: type_output) => void): void; /** * @author fenris * @desc creates a deferral-subject (similar to "new Promise", where "convey" reflects "resolve"/"reject") */ function deferral_make(handler: (input: type_input, convey: (output: type_output) => void) => void): type_deferral; /** * @author fenris * @desc wraps a simple function into a deferral (similar to "Promise.resolve"/"Promise.reject") */ function deferral_wrap(function_: (input: type_input) => type_output): type_deferral; /** * @author fenris */ function deferral_id(): type_deferral; /** * @author fenris */ function deferral_const(value: type_value): type_deferral; /** * @author fenris */ function deferral_delay(output: type_output, delay: int): type_deferral; /** * @author fenris * @desc connects two deferrals to form a new one; the output of the first is taken as input for the second * (similar to "Promise.then" when passing a function which returns a new promise) * @param {type_deferral} first a simple deferral * @param {(value1 : type_value1)=>type_deferral} second a function depending from a value returning a deferral */ function deferral_compose_serial(first: type_deferral, second: type_deferral): type_deferral; /** * @author fenris */ function deferral_compose_parallel({ "left": deferral_left, "right": deferral_right, }: { left: type_deferral; right: type_deferral; }): type_deferral; /** * @author fenris * @desc repeatedly applied serial composition */ function deferral_chain(members: Array>): type_deferral; /** * @author fenris */ } declare namespace lib_plankton.call { /** * @author fenris */ class class_deferral { /** * @author fenris */ private subject; /** * @author fenris */ private constructor(); /** * @author fenris */ private static _cram; /** * @author fenris */ private static _tear; /** * @author fenris */ static make(handler: (input: type_input, convey: (value: type_output) => void) => void): class_deferral; /** * @author fenris */ use(input: type_input, procedure: (value: type_output) => void): void; /** * @author fenris */ compose_serial(second: class_deferral): class_deferral; /** * @author fenris */ static chain(members: Array>): class_deferral; /** * @author fenris */ static wrap(function_: (input: type_input) => type_output): class_deferral; /** * @author fenris */ static const_(value: type_value): class_deferral; /** * @author fenris */ static delay(output: type_output, delay: int): class_deferral; } } declare namespace lib_plankton.call { /** * converts the "arguments"-map into an array * * @param {Object} args * @author fenris */ export function args2list(args: any): Array; /** * just the empty function; useful for some callbacks etc. * * @author fenris */ export function nothing(): void; /** * just the identity; useful for some callbacks etc.; defined as function instead of const for using type parameters * * @author fenris */ export function id(x: type_value): type_value; /** * just the identity; useful for some callbacks etc. * * @author fenris */ export function const_(x: type_value): ((y: any) => type_value); /** * composes two functions (i.e. returns a function that return the result of the successive execution of both input-functions) * * @param {function} function_f * @param {function} function_g * @author fenris */ export function compose(function_f: ((type_x: any) => type_y), function_g: ((type_y: any) => type_z)): ((value: type_x) => type_z); /** * transforms a function with sequential input to a function with leveled input; example: add(2,3) = curryfy(add)(2)(3) * * @param {function} f * @return {function} the currified version of the in put function * @author fenris */ export function curryfy(f: Function): Function; /** * @author fenris */ export function convey(value: any, functions: Array): any; /** */ class class_value_wrapper { /** */ private value; /** */ constructor(value: type_value); /** */ convey(function_: ((value: type_value) => type_value_result)): class_value_wrapper; /** */ cull(): type_value; } /** */ export function wrap(value: type_value): class_value_wrapper; /** * @author fenris */ export function timeout(procedure: (() => void), delay_in_seconds: float): int; /** * Promise version of "setTimeout" * * @author fenris */ export function defer(seconds: float, action: (() => type_result)): Promise; /** * a definition for a value being "defined" * * @author neuc */ export function is_def(obj: type_value, options?: { null_is_valid?: boolean; }): boolean; /** * returns the value if set and, when a type is specified, if the type is correct, if not return default_value * * @author neuc */ export function def_val(value: any, default_value: any, options?: { type?: (null | string); null_is_valid?: boolean; }): any; /** * provides the call for an attribute of a class as a regular function; useful for processing lists of objects * * @param {string} name the name of the attribute * @return {function} * @author fenris */ export function attribute(name: string): ((object: type_object) => type_attribute); /** * provides a method of a class as a regular function; useful for processing lists of objects * * @param {string} name the name of the method * @return {function} * @author fenris */ export function method(name: string): ((object: type_object) => type_output); /** * @author fenris */ export type type_coproduct = { kind: string; data?: any; }; /** * @author fenris */ export function distinguish(coproduct: type_coproduct, handlers: Record type_output)>, options?: { fallback?: (null | ((coproduct?: type_coproduct) => type_output)); }): type_output; /** */ export function try_catch_wrap(get_value: (() => type_value)): { value: (null | type_value); error: (null | any); }; /** */ export function try_catch_wrap_async(get_value: (() => Promise)): Promise<{ value: (null | type_value); error: (null | any); }>; export {}; } declare namespace lib_plankton.pair { /** */ type type_pair = { first: type_first; second: type_second; }; } declare namespace lib_plankton.pair { /** */ function swap(pair: type_pair): type_pair; /** */ function show(pair: type_pair, options?: { show_first?: ((first: type_first) => string); show_second?: ((second: type_second) => string); }): string; } declare namespace lib_plankton.list { /** */ type type_separation = { yes: Array; no: Array; }; /** */ type type_result_max = (null | { index: int; element: type_element; value: type_value; }); } declare namespace lib_plankton.list { /** * returns a certain list of integer numbers */ function range(from: int, to: int, options?: { step?: int; }): Array; /** * returns a certain list of consecutiv integer numbers, beginning with 0 */ function sequence(length: int): Array; /** */ function from_iterator(iterator: Iterator): Array; /** */ function is_empty(list: Array): boolean; /** * combines two lists into one * * @param {boolean} [options.cut] whether the result list will be as long as the shortest input list or an exception is thrown if they have different lengths; default: true */ function zip(list_first: Array, list_second: Array, options?: { cut?: boolean; }): Array>; /** * checks whether two lists are equal * * @todo define common function "equals" and default predicate to */ function equals(list1: Array, list2: Array, options?: { collate_element?: ((element1: type_element, element2: type_element) => boolean); }): boolean; /** * creates a list with the elements from the input list, which fulfil a certain predicate (~ filter) */ function keep(list: Array, predicate: ((element: type_element) => boolean)): Array; /** * creates a list with the elements from the input list, which do not fulfil a certain predicate (~ dual filter) */ function drop(list: Array, predicate: ((element: type_element) => boolean)): Array; /** */ function filter_inplace(list: Array, predicate: ((element: type_element) => boolean)): void; /** * returns a list with no duplicates (like unix' "unique") */ function cleaned(list: Array, options?: { collate_element?: ((x: type_element, y: type_element) => boolean); }): Array; /** * creates a binary partition of the list according to a given predicate */ function separate(list: Array, predicate: ((element: type_element) => boolean)): type_separation; /** */ function clone(list: Array): Array; /** */ function reversed(list: Array): Array; /** * @todo use Array.toSorted? */ function sorted(list: Array, options: { compare_element?: ((element1: type_element, element2: type_element) => boolean); }): Array; /** * die Liste in gleich große Blöcke zerlegen */ function chop(list: Array, chunk_size: int): Array>; /** */ function group(list: Array, collate_element: ((x: type_element, y: type_element) => boolean)): Array>; /** */ function has(list: Array, predicate: ((element: type_element) => boolean)): boolean; /** * @deprecate use Array.includes or Array.some */ function contains(list: Array, element: type_element, options: { collate_element?: ((element1: type_element, element2: type_element) => boolean); }): boolean; /** * retrieves the element and its index of the list, which has the maximum value */ function max(list: Array, target_function: ((element: type_element) => type_value), options: { compare_value: ((value1: type_value, value2: type_value) => boolean); }): type_result_max; /** * retrieves the element and its index of the list, which has the mininum value */ function min(list: Array, target_function: (element: type_element) => type_value, options: { compare_value: ((value1: type_value, value2: type_value) => boolean); }): type_result_max; /** * implements the idea of arithmetic distribution like in "(a+b)·(c+d) = (a·c)+(a·d)+(b·c)+(b·d)" * example: distribute([[1,2],[3],[4,5,6]]) = [[1,3,4],[1,3,5],[1,3,6],[2,3,4],[2,3,5],[2,3,6]] */ function distribute(lists: Array>): Array>; /** */ function contrast(list_left: Array, extract_key_left: ((left: type_left) => string), list_right: Array, extract_key_right: ((right: type_right) => string)): { both: Array<{ key: string; left: type_left; right: type_right; }>; only_left: Array<{ key: string; left: type_left; }>; only_right: Array<{ key: string; right: type_right; }>; }; } declare namespace lib_plankton.file { /** * @author fenris */ function exists(path: string): Promise; /** * @author fenris */ function read(path: string): Promise; /** * @author fenris */ function read_buffer(path: string): Promise; /** * @author fenris */ function read_stdin(): Promise; /** * @author fenris */ function write(path: string, content: string, options?: { encoding?: string; }): Promise; /** * @author fenris */ function write_buffer(path: string, content: Buffer, options?: {}): Promise; /** */ function delete_(path: string): Promise; } declare namespace lib_plankton.email { /** */ function send(smtp_credentials: { host: string; port: int; username: string; password: string; }, sender: string, receivers: Array, subject: string, content: string): Promise; } declare namespace lib_plankton.log { /** */ enum enum_level { debug = 0, info = 1, notice = 2, warning = 3, error = 4 } /** */ type type_entry = { level: enum_level; incident: string; tags: Array; details: any; }; /** */ type type_channel_description = lib_plankton.call.type_coproduct; /** */ type type_channel_logic = { send: ((entry: type_entry) => void); }; /** */ type type_logger_data = Array; /** */ type type_logger_logic = Array; /** */ type type_format_definition = ({ kind: "jsonl"; data: { structured: boolean; }; } | { kind: "human_readable"; data: {}; }); } declare namespace lib_plankton.log { /** */ function level_order(level1: enum_level, level2: enum_level): boolean; /** */ function level_show(level: enum_level, { "abbreviated": option_abbreviated, }?: { abbreviated?: boolean; }): string; /** */ function level_decode(level_string: string): enum_level; } declare namespace lib_plankton.log { /** * @todo use label */ function get_logger_logic(logger_data: type_logger_data): type_logger_logic; /** */ function format_entry(format_definition: type_format_definition, entry: type_entry): string; /** */ function parse_format_definition(format_definition_raw: any): type_format_definition; } declare namespace lib_plankton.log.channel.filtered { /** */ type type_predicate = ((entry: type_entry) => boolean); /** */ type type_subject = { /** * @todo check if it has to be logic */ core: type_channel_logic; predicate: type_predicate; }; /** */ function predicate_incident(substring: string): type_predicate; /** */ function predicate_level(threshold: enum_level): type_predicate; /** */ function predicate_tag(tag: string): type_predicate; /** * combines other predicates in disjunctive normal form */ function predicate_complex(definition: Array>): type_predicate; /** */ function send(subject: type_subject, entry: type_entry): void; /** */ function logic(subject: type_subject): type_channel_logic; } declare namespace lib_plankton.log.channel.minlevel { /** */ type type_subject = { /** * @todo check if it has to be logic */ core: type_channel_logic; threshold: enum_level; }; /** */ function send(subject: type_subject, entry: type_entry): void; /** */ function logic(subject: type_subject): type_channel_logic; } declare namespace lib_plankton.log.channel.std { /** */ type type_subject = { target: ("stdout" | "stderr"); format: type_format_definition; }; /** */ function send(subject: type_subject, entry: type_entry): void; /** */ function logic(subject: type_subject): type_channel_logic; } declare namespace lib_plankton.log.channel.file { /** */ type type_subject = { path: string; format: type_format_definition; }; /** */ function send(subject: type_subject, entry: type_entry): void; /** */ function logic(subject: type_subject): type_channel_logic; } declare namespace lib_plankton.log.channel.notify { /** */ type type_subject = {}; /** * @todo tags */ function send(subject: type_subject, entry: type_entry): void; /** */ function logic(subject: type_subject): type_channel_logic; } declare namespace lib_plankton.log.channel.email { /** */ type type_subject = { smtp_credentials: { host: string; port: int; username: string; password: string; }; sender: string; receivers: Array; }; /** * @todo tags */ function send(subject: type_subject, entry: type_entry): void; /** */ function logic(subject: type_subject): type_channel_logic; } declare namespace lib_plankton.log { /** */ function get_channel_logic(channel_description: type_channel_description): type_channel_logic; } declare namespace lib_plankton.log { /** */ function default_logger(): type_logger_data; } declare namespace lib_plankton.log { /** */ function set_main_logger(logger_data: type_logger_data): void; /** * consumes a log entry, i.e. sends it to all channels */ function send_(logger: type_logger_logic, entry: type_entry): void; /** * [convenience] * * @todo rename to "send" */ function debug_(logger: type_logger_logic, incident: string, { "tags": option_tags, "details": option_details, }?: { tags?: Array; details?: any; }): void; /** * [convenience] * * @todo rename to "info" */ function info_(logger: type_logger_logic, incident: string, { "tags": option_tags, "details": option_details, }?: { tags?: Array; details?: any; }): void; /** * [convenience] * * @todo rename to "notice" */ function notice_(logger: type_logger_logic, incident: string, { "tags": option_tags, "details": option_details, }?: { tags?: Array; details?: any; }): void; /** * [convenience] * * @todo rename to "warning" */ function warning_(logger: type_logger_logic, incident: string, { "tags": option_tags, "details": option_details, }?: { tags?: Array; details?: any; }): void; /** * [convenience] * * @todo rename to "error" */ function error_(logger: type_logger_logic, incident: string, { "tags": option_tags, "details": option_details, }?: { tags?: Array; details?: any; }): void; /** * [convenience] */ function _send(entry: type_entry): void; /** * [convenience] */ function _debug(incident: string, { "tags": option_tags, "details": option_details, }?: { tags?: Array; details?: any; }): void; /** * [convenience] */ function _info(incident: string, { "tags": option_tags, "details": option_details, }?: { tags?: Array; details?: any; }): void; /** * [convenience] */ function _notice(incident: string, { "tags": option_tags, "details": option_details, }?: { tags?: Array; details?: any; }): void; /** * [convenience] */ function _warning(incident: string, { "tags": option_tags, "details": option_details, }?: { tags?: Array; details?: any; }): void; /** * [convenience] */ function _error(incident: string, { "tags": option_tags, "details": option_details, }?: { tags?: Array; details?: any; }): void; /** * [convenience] * * @deprecated use ._debug instead! */ function debug(incident: string, details?: any, tags?: Array): void; /** * [convenience] * * @deprecated use ._info instead! */ function info(incident: string, details?: any, tags?: Array): void; /** * [convenience] * * @deprecated use ._notice instead! */ function notice(incident: string, details?: any, tags?: Array): void; /** * [convenience] * * @deprecated use ._warning instead! */ function warning(incident: string, details?: any, tags?: Array): void; /** * [convenience] * * @deprecated use ._error instead! */ function error(incident: string, details?: any, tags?: Array): void; } declare var plain_text_to_html: (text: string) => string; /** * @desc makes a valid */ declare var format_sentence: (str: string, rtl?: boolean, caseSense?: boolean) => string; declare var fill_string_template: (template_string: string, object: any, fabric: Function, delimiter: string, default_string: string, sloppy: boolean) => string; declare var make_string_template: (_template: string, _fabrics?: Object) => (object: { [key: string]: string; }) => string; declare var make_eml_header: (object: { [key: string]: string; }) => string; declare var make_eml_body: Object; declare namespace lib_plankton.string { /** * @author neuc,frac */ function empty(str: string): boolean; /** * @desc returns a unique string * @param {string} prefix an optional prefix for the generated string * @return {string} * @author fenris */ function generate(prefix?: string): string; /** * @author fenris */ function join(parts: Array, glue?: string): string; /** * @desc splits a string, but returns an empty list, if the string is empty * @param {string} chain * @param {string} separator * @return {Array} * @author fenris */ function split(chain: string, separator: string): Array; /** * @author neu3no */ function explode(str: string, needle: string, max: int): Array; /** * @desc concats a given word with itself n times * @param {string} word * @param {int} * @return {string} * @author fenris */ function repeat(word: string, count: int): string; /** * @desc lengthens a string by repeatedly appending or prepending another string * @param {string} word the string to pad * @param {int} length the length, which the result shall have * @param {string} symbol the string, which will be added (multiple times) * @param {boolean} [prepend]; whether to prepend (~true) or append (~false); default: false * @return {string} the padded string * @author fenris */ function pad(word: string, length: int, symbol?: string, mode?: string): string; /** * @desc checks if a given string conttains a certain substring * @param {string} string * @param {string} part * @return {boolean} * @author fenris */ function contains(chain: string, part: string): boolean; /** * @desc checks if a given string starts with a certain substring * @param {string} string * @param {string} part * @return {boolean} * @author fenris */ function startsWith(chain: string, part: string): boolean; /** * @desc checks if a given string ends with a certain substring * @param {string} string * @param {string} part * @return {boolean} * @author fenris */ function endsWith(chain: string, part: string): boolean; /** * @desc count the occourrences of a string in a string * @param string haystack_string the string wich should be examined * @param string needle_string the string which should be counted * @author neuc */ function count_occourrences(haystack_string: string, needle_string: string, check_escape: boolean): int; /** * @author fenris */ function replace(str: string, replacements: Array<{ from: string; to: string; }>, options?: {}): string; /** * @desc replaces occurences of "{{name}}" in a string by the corresponding values of an argument object * @author fenris */ function coin(str: string, args: { [id: string]: string; }, options?: { legacy?: boolean; open?: string; close?: string; }): string; /** * @author fenris * @deprecated use limit */ function cut(str: string, length: int, delimiter?: string): string; /** */ function limit(str: string, options?: { length?: int; indicator?: string; }): string; /** */ function slice(str: string, size: int): Array; /** */ function capitalize(str: string): string; } /** * @deprecated */ declare namespace lib_string { const empty: typeof lib_plankton.string.empty; const generate: typeof lib_plankton.string.generate; const split: typeof lib_plankton.string.split; const explode: typeof lib_plankton.string.repeat; const repeat: typeof lib_plankton.string.repeat; const pad: typeof lib_plankton.string.pad; const contains: typeof lib_plankton.string.contains; const startsWith: typeof lib_plankton.string.startsWith; const endsWith: typeof lib_plankton.string.endsWith; const count_occourrences: typeof lib_plankton.string.count_occourrences; const coin: typeof lib_plankton.string.coin; const stance: typeof lib_plankton.string.coin; const cut: typeof lib_plankton.string.cut; } declare namespace lib_plankton.string { /** * an implementation of c sprintf * @param {string} string format string * @param {array} args arguments which should be filled into * @returns {string} */ var sprintf: (input: string, args?: Array, original?: any) => string; /** * an implementation of c printf * @param {string} string format string * @param {array} args arguments which should be filled into * @returns {string} */ function printf(format: any, args: any): void; } declare var sprintf: (input: string, args?: Array, original?: any) => string; declare var printf: typeof lib_plankton.string.printf; declare var eml_log: any; declare var track_exports: any; declare var make_logger: (prefix: any, current_loglevel: any) => (obj: any, lvl: any) => void; declare namespace lib_plankton.shape { /** * @todo */ type type_jsonschema = any; /** * @todo */ type type_oas_schema = any; /** * @author fenris */ type type_inspection = { flaws: Array; sub: Array<{ position: string; inspection: type_inspection; }>; }; /** * @author fenris */ function inspection_create(): type_inspection; /** * @author fenris */ function inspection_add(main: type_inspection, flaw: string): void; /** * @author fenris */ function inspection_extend(main: type_inspection, prefix: string, sub: type_inspection): void; /** */ type type_shape = { kind: string; parameters: Record; }; /** * @author fenris */ type type_logic = { inspect: ((sub_inspect: ((shape: type_shape, value: any) => type_inspection), value: any) => type_inspection); show: ((sub_show: ((shape: type_shape) => string)) => string); to_typescript_type: ((sub_to_typescript_type: ((shape: type_shape) => string)) => string); to_jsonschema: ((sub_to_json_schema: ((shape: type_shape) => type_jsonschema)) => type_jsonschema); to_oas_schema: ((sub_to_oas_schema: ((shape: type_shape) => type_oas_schema)) => type_oas_schema); example: ((sub_example: ((shape: type_shape) => any)) => any); }; /** */ function inspect(shape: type_shape, value: any): type_inspection; /** */ function inspect_flat(shape: type_shape, value: any): Array; /** */ function show(shape: type_shape): string; /** */ function to_typescript_type(shape: type_shape): string; /** */ function to_jsonschema(shape: type_shape): type_jsonschema; /** */ function to_oas_schema(shape: type_shape): type_oas_schema; /** */ function example(shape: type_shape): any; /** */ function register(name: string, construct: ((parameters: type_parameters) => type_subject), logic: ((subject: type_subject) => type_logic)): void; } declare namespace lib_plankton.shape.any { /** */ type type_subject = {}; /** */ export function make(options?: {}): type_subject; export {}; } declare namespace lib_plankton.shape.null_ { /** */ type type_subject = {}; /** */ export function make(options?: {}): type_subject; export {}; } declare namespace lib_plankton.shape.boolean { /** */ type type_subject = { soft: boolean; defaultvalue: lib_plankton.pod.type_pod; description: lib_plankton.pod.type_pod; }; /** */ export function make(options?: { soft?: boolean; defaultvalue?: (null | boolean); description?: string; }): type_subject; export {}; } declare namespace lib_plankton.shape.integer { /** */ type type_subject = { soft: boolean; defaultvalue: lib_plankton.pod.type_pod; description: lib_plankton.pod.type_pod; minimum: lib_plankton.pod.type_pod; maximum: lib_plankton.pod.type_pod; }; /** */ export function make(options?: { soft?: boolean; defaultvalue?: (null | int); description?: string; minimum?: int; maximum?: int; }): type_subject; export {}; } declare namespace lib_plankton.shape.float { /** */ type type_subject = { soft: boolean; defaultvalue: lib_plankton.pod.type_pod; description: lib_plankton.pod.type_pod; minimum: lib_plankton.pod.type_pod; maximum: lib_plankton.pod.type_pod; }; /** */ export function make(options?: { soft?: boolean; defaultvalue?: (null | float); description?: string; minimum?: float; maximum?: float; }): type_subject; export {}; } declare namespace lib_plankton.shape.string { /** */ type type_subject = { soft: boolean; defaultvalue: lib_plankton.pod.type_pod; description: lib_plankton.pod.type_pod; pattern: lib_plankton.pod.type_pod; min_length: lib_plankton.pod.type_pod; max_length: lib_plankton.pod.type_pod; }; /** */ export function make(options?: { soft?: boolean; defaultvalue?: (null | int); description?: string; pattern?: string; min_length?: int; max_length?: int; }): type_subject; export {}; } declare namespace lib_plankton.shape.email { /** */ type type_subject = { core: type_shape; }; /** */ export function make(options?: { soft?: boolean; defaultvalue?: (null | int); description?: string; }): type_subject; export {}; } declare namespace lib_plankton.shape.list_ { /** */ type type_subject = { shape_element: type_shape; soft: boolean; defaultvalue: lib_plankton.pod.type_pod; description: lib_plankton.pod.type_pod; }; /** */ export function make(shape_element: type_shape, options?: { soft?: boolean; defaultvalue?: any; description?: string; }): type_subject; export {}; } declare namespace lib_plankton.shape.map { /** */ type type_subject = { shape_key: type_shape; shape_value: type_shape; soft: boolean; defaultvalue: lib_plankton.pod.type_pod; description: lib_plankton.pod.type_pod; }; /** */ export function make(shape_key: type_shape, shape_value: type_shape, options?: { soft?: boolean; defaultvalue?: any; description?: string; }): type_subject; export {}; } declare namespace lib_plankton.shape.record { /** */ type type_field = { name: string; shape: type_shape; required: boolean; }; /** */ type type_subject = { fields: Array; soft: boolean; defaultvalue: lib_plankton.pod.type_pod; description: lib_plankton.pod.type_pod; }; /** */ export function make(fields_raw: Array<{ name: string; shape: type_shape; required?: boolean; }>, options?: { soft?: boolean; defaultvalue?: any; description?: string; }): type_subject; export {}; } declare namespace lib_plankton.code { /** * @author fenris */ interface interface_code { /** * @author fenris */ encode(x: type_from): type_to; /** * @author fenris */ decode(x: type_to): type_from; } } declare namespace lib_plankton.code { /** * @author fenris */ type type_code = { /** * @author fenris */ encode: (x: type_from) => type_to; /** * @author fenris */ decode: (x: type_to) => type_from; }; } declare namespace lib_plankton.code { /** * @author fenris */ function inverse_encode(decode: (to: type_to) => type_from, to: type_to): type_from; /** * @author fenris */ function inverse_decode(encode: (from: type_from) => type_to, from: type_from): type_to; } declare namespace lib_plankton.code { /** * @author fenris */ class class_code_inverse implements interface_code { /** * @author fenris */ protected subject: interface_code; /** * @author fenris */ constructor(subject: interface_code); /** * @implementation * @author fenris */ encode(to: type_to): type_from; /** * @implementation * @author fenris */ decode(from: type_from): type_to; } } declare namespace lib_plankton.code { /** * @author fenris */ function pair_encode(encode_first: (from: type_from) => type_between, encode_second: (between: type_between) => type_to, from: type_from): type_to; /** * @author fenris */ function pair_decode(decode_first: (between: type_between) => type_from, decode_second: (to: type_to) => type_between, to: type_to): type_from; } declare namespace lib_plankton.code { /** * @author fenris */ class class_code_pair implements interface_code { /** * @author fenris */ protected first: interface_code; /** * @author fenris */ protected second: interface_code; /** * @author fenris */ constructor(first: interface_code, second: interface_code); /** * @implementation * @author fenris */ encode(from: type_from): type_to; /** * @implementation * @author fenris */ decode(to: type_to): type_from; } } declare namespace lib_plankton.code { /** * @author fenris */ function chain_encode(encode_links: Array<(from: any) => any>, from: any): any; /** * @author fenris */ function chain_decode(decode_links: Array<(to: any) => any>, to: any): any; } declare namespace lib_plankton.code { /** * @author fenris */ class class_code_chain implements interface_code { /** * @author fenris */ protected links: Array>; /** * @author fenris */ constructor(links: Array>); /** * @implementation * @author fenris */ encode(from: any): any; /** * @implementation * @author fenris */ decode(to: any): any; } } declare namespace lib_plankton.code { /** * @author Christian Fraß */ type type_flatten_from = Array<{ [name: string]: any; }>; /** * @author Christian Fraß */ type type_flatten_to = { keys: Array; data: Array>; }; /** * @author Christian Fraß */ function flatten_encode(from: type_flatten_from, keys?: Array): type_flatten_to; /** * @author Christian Fraß */ function flatten_decode(to: type_flatten_to): type_flatten_from; } declare namespace lib_plankton.code { /** * @author fenris */ class class_code_flatten implements interface_code { /** * @author fenris */ constructor(); /** * @implementation * @author fenris */ encode(x: type_flatten_from): type_flatten_to; /** * @implementation * @author fenris */ decode(x: type_flatten_to): type_flatten_from; } } declare namespace lib_plankton.www_form { /** */ type type_source = Record; /** */ type type_target = string; /** * @author fenris */ function encode(source: type_source): type_target; /** * @author fenris */ function decode(target: type_target): type_source; } declare namespace lib_plankton.www_form { /** * @author fenris */ class class_www_form implements lib_plankton.code.interface_code { /** * @author fenris */ constructor(); /** * @implementation * @author fenris */ encode(source: type_source): type_target; /** * @implementation * @author fenris */ decode(target: type_target): type_source; } } declare namespace lib_plankton.url { /** * @author fenris */ type type_url = { scheme: (null | string); host: (null | string); username: (null | string); password: (null | string); port: (null | int); path: (null | string); query: (null | string); hash: (null | string); }; } declare namespace lib_plankton.url { /** * @author fenris */ function encode(url: type_url): string; /** * @author fenris * @todo arguments */ function decode(url_raw: string): type_url; /** * @author fenris */ function implementation_code(): lib_plankton.code.type_code; } declare namespace lib_plankton.url { /** * @author fenris */ class class_url implements lib_plankton.code.interface_code { /** * @author fenris */ constructor(); /** * @implementation * @author fenris */ encode(x: any): string; /** * @implementation * @author fenris */ decode(x: string): any; } } declare namespace lib_plankton.random { /** * @author fenris */ type type_state = { builtin: boolean; seed?: int; }; /** * @author fenris */ function state_push(state: type_state): void; /** * @author fenris */ function state_pop(): type_state; /** * returns a random floating point number in the interval [0,1[ * * @author fenris */ function generate_unit(): float; /** * returns a random boolean value * * @param {float} [probability] the probability for the return-value "true"; default: 0.5 * @author fenris */ function generate_boolean(options?: { probability?: float; }): boolean; /** * returns a random integer number in the interval [a,b] * * @param {int} [minimum] the left side of the halfopen interval (i.e. the smallest included value in the range) * @param {int} [minimum] the right side of the halfopen interval (i.e. the smallest excluded value in the range) * @author fenris */ function generate_integer(options?: { minimum?: int; maximum?: int; }): int; var generate_int: typeof generate_integer; /** * returns a random floating point number in the given interval * * @author fenris */ function generate_float(options?: { minimum?: int; maximum?: int; }): float; /** * returns a random date * * @author fenris */ function generate_date(options?: { minimum?: Date; maximum?: Date; }): Date; /** * @author fenris */ function generate_hexdigit(): string; /** * generates a random string with an optional prefix * * @author fenris */ function generate_string(options?: { length?: int; }): string; /** * chooses a value randomly from a list of values with weights (a higher weight means a higher probability to be chosen) * * @author fenris */ function choose_weighted(sets: Array<{ weight: float; value: type_value; }>): type_value; /** * chooses a value randomly from a list of values with equal probabilities * * @author fenris */ function choose_uniformly(values: Array): type_value; /** * @author fenris */ function shuffle(list: Array): Array; /** * @author fenris */ function generate_vowel(): string; /** * @author fenris */ function generate_halfvowel(): string; /** * @author fenris */ function generate_consonant(): string; /** * @author fenris */ function generate_letter(): string; /** * @author fenris */ function generate_syllable(): string; /** * @author fenris */ function generate_word(options?: { syllable_count_minimum?: int; syllable_count_maximum?: int; }): string; /** * @author fenris */ function generate_text(options?: { word_count?: int; }): string; /** * @author fenris */ function generate_city(): string; /** * @author fenris */ function generate_street(): string; /** * @author fenris */ function generate_guid(options?: { with_braces?: boolean; }): string; /** * @author fenris */ function generate_url(): string; /** * @author fenris */ function generate_email_address(): string; /** * @author fenris */ function generate_telephone_number(): string; /** * @author fenris */ function generate_time(): any; /** * @author fenris * @deprecated * @todo remove */ function generate_for_shape(shape: any): any; /** * @author fenris */ } declare namespace lib_plankton.sha256 { /** * @author fenris */ function get(value: string, secret?: string): string; } declare namespace lib_plankton.database { /** */ type type_query = { template: string; arguments: Record; }; /** */ enum enum_type { boolean = "boolean", integer = "integer", string_short = "string_short", string_medium = "string_medium", string_long = "string_long", float = "float" } /** */ type type_description_create_table = { name: string; key_field?: (null | { name: string; type?: enum_type; comment?: (null | string); auto_increment?: (null | boolean); description?: (null | string); }); data_fields?: Array<{ name: string; nullable?: boolean; type: enum_type; default?: any; description?: (null | string); }>; constraints?: Array<{ kind: string; parameters?: Record; }>; description?: (null | string); }; /** */ type type_description_insert = { table_name: string; values: Record; returning?: (null | string); }; /** */ type type_description_update = { table_name: string; values: Record; condition?: (null | string); arguments?: (null | Record); }; /** */ type type_description_delete = { table_name: string; condition?: (null | string); arguments?: (null | Record); }; /** */ type type_description_select = { source: string; fields?: (null | Array); condition?: (null | string); group_by?: (null | string); having?: (null | string); order_by?: (null | string); limit?: (null | int); arguments?: (null | Record); }; /** * rows */ type type_result_get = Array>; /** * auto insert id */ type type_result_put = (null | int); /** * number of affected rows */ type type_result_set = int; /** * @author fenris */ type type_database = { wrap_name: ((name: string) => string); query_free_get: ((query: type_query) => Promise); query_free_put: ((query: type_query) => Promise); query_free_set: ((query: type_query) => Promise); query_create_table: ((description_create_table: type_description_create_table) => Promise); query_insert: ((description_insert: type_description_insert) => Promise); query_update: ((description_update: type_description_update) => Promise); query_delete: ((description_delete: type_description_delete) => Promise); query_select: ((description_select: type_description_select) => Promise); }; /** */ type interface_database = database.type_database; } declare namespace lib_plankton.database { /** * @todo default case? */ function sql_common_value_format(value: any): string; /** */ function sql_common_formulation_create_table(description_create_table: type_description_create_table, options?: { auto_increment_keyword?: (null | string); auto_increment_special?: (null | string); omit_comments?: boolean; type_map?: Record; wrap_name?: ((name: string) => string); }): type_query; /** */ function sql_common_formulation_insert(description_insert: type_description_insert, options?: { wrap_name?: ((name: string) => string); set_returning?: boolean; }): type_query; /** */ function sql_common_formulation_update(description_update: type_description_update, options?: { wrap_name?: ((name: string) => string); }): type_query; /** */ function sql_common_formulation_delete(description_delete: type_description_delete, options?: { wrap_name?: ((name: string) => string); }): type_query; /** */ function sql_common_formulation_select(description_select: type_description_select, options?: { wrap_name?: ((name: string) => string); }): type_query; } declare namespace lib_plankton.database { /** */ type type_sqlite_subject = { path: string; handle: any; }; /** */ type type_sqlite_parameters = { path: string; }; /** */ function sqlite_make(parameters: type_sqlite_parameters): type_sqlite_subject; /** */ function sqlite_wrap_name(name: string): string; /** * @author fenris */ function sqlite_query_free_get(subject: type_sqlite_subject, query: type_query): Promise; /** * @author fenris */ function sqlite_query_free_put(subject: type_sqlite_subject, query: type_query): Promise; /** * @author fenris */ function sqlite_query_free_set(subject: type_sqlite_subject, query: type_query): Promise; /** */ function sqlite_formulation_create_table(description_create_table: type_description_create_table): type_query; /** */ function sqlite_query_create_table(subject: type_sqlite_subject, description: type_description_create_table): Promise; /** */ function sqlite_formulation_insert(description_insert: type_description_insert): type_query; /** */ function sqlite_query_insert(subject: type_sqlite_subject, description_insert: type_description_insert): Promise; /** */ function sqlite_formulation_update(description_update: type_description_update): type_query; /** */ function sqlite_query_update(subject: type_sqlite_subject, description_update: type_description_update): Promise; /** */ function sqlite_formulation_delete(description_delete: type_description_delete): type_query; /** */ function sqlite_query_delete(subject: type_sqlite_subject, description_delete: type_description_delete): Promise; /** */ function sqlite_formulation_select(description_select: type_description_select): type_query; /** */ function sqlite_query_select(subject: type_sqlite_subject, description_select: type_description_select): Promise>>; /** */ function sqlite_database(parameters: type_sqlite_parameters): type_database; } declare namespace lib_plankton.database { /** * @author fenris */ class class_sqlite implements interface_database { private subject; constructor(parameters: type_sqlite_parameters); wrap_name(name: any): string; query_free_get(query: any): Promise; query_free_put(query: any): Promise; query_free_set(query: any): Promise; query_create_table(description_create_table: any): Promise; query_insert(description_insert: any): Promise; query_update(description_update: any): Promise; query_delete(description_delete: any): Promise; query_select(description_select: any): Promise[]>; } } declare namespace lib_plankton.database { /** * @todo */ type type_postgresql_subject = { host: string; port: int; username: string; password: string; schema: string; pool: (null | any); }; /** * @todo */ type type_postgresql_parameters = { host: string; port?: int; username: string; password: string; schema: string; }; /** */ function postgresql_make(parameters: type_postgresql_parameters): type_postgresql_subject; /** */ function postgresql_wrap_name(name: string): string; /** * @author fenris * @see https://node-postgres.com/apis/pool#poolquery */ function postgresql_query_free_get(subject: type_postgresql_subject, query: type_query): Promise; /** * @author fenris * @see https://node-postgres.com/apis/pool#poolquery */ function postgresql_query_free_put(subject: type_postgresql_subject, query: type_query): Promise; /** * @author fenris * @see https://node-postgres.com/apis/pool#poolquery */ function postgresql_query_free_set(subject: type_postgresql_subject, query: type_query): Promise; /** */ function postgresql_formulation_create_table(description_create_table: type_description_create_table): type_query; /** */ function postgresql_query_create_table(subject: type_postgresql_subject, description: type_description_create_table): Promise; /** */ function postgresql_formulation_insert(description_insert: type_description_insert): type_query; /** */ function postgresql_query_insert(subject: type_postgresql_subject, description_insert: type_description_insert): Promise; /** */ function postgresql_formulation_update(description_update: type_description_update): type_query; /** */ function postgresql_query_update(subject: type_postgresql_subject, description_update: type_description_update): Promise; /** */ function postgresql_formulation_delete(description_delete: type_description_delete): type_query; /** */ function postgresql_query_delete(subject: type_postgresql_subject, description_delete: type_description_delete): Promise; /** */ function postgresql_formulation_select(description_select: type_description_select): type_query; /** */ function postgresql_query_select(subject: type_postgresql_subject, description_select: type_description_select): Promise>>; /** */ function postgresql_database(parameters: type_postgresql_parameters): type_database; } declare namespace lib_plankton.database { /** * @author fenris */ class class_postgresql implements interface_database { private subject; constructor(parameters: type_postgresql_parameters); wrap_name(name: any): string; query_free_get(query: any): Promise; query_free_put(query: any): Promise; query_free_set(query: any): Promise; query_create_table(description_create_table: any): Promise; query_insert(description_insert: any): Promise; query_update(description_update: any): Promise; query_delete(description_delete: any): Promise; query_select(description_select: any): Promise[]>; } } declare namespace lib_plankton.database { /** * @todo */ type type_mysql_subject = { verbose: boolean; }; /** * @todo */ type type_mysql_parameters = { verbose?: boolean; }; /** */ function mysql_make(parameters: type_mysql_parameters): type_mysql_subject; /** */ function mysql_wrap_name(name: string): string; /** * @author fenris */ function mysql_query_free_get(subject: type_mysql_subject, query: type_query): Promise; /** * @author fenris */ function mysql_query_free_put(subject: type_mysql_subject, query: type_query): Promise; /** * @author fenris */ function mysql_query_free_set(subject: type_mysql_subject, query: type_query): Promise; /** */ function mysql_formulation_create_table(description_create_table: type_description_create_table): type_query; /** */ function mysql_query_create_table(subject: type_mysql_subject, description: type_description_create_table): Promise; /** */ function mysql_formulation_insert(description_insert: type_description_insert): type_query; /** */ function mysql_query_insert(subject: type_mysql_subject, description_insert: type_description_insert): Promise; /** */ function mysql_formulation_update(description_update: type_description_update): type_query; /** */ function mysql_query_update(subject: type_mysql_subject, description_update: type_description_update): Promise; /** */ function mysql_formulation_delete(description_delete: type_description_delete): type_query; /** */ function mysql_query_delete(subject: type_mysql_subject, description_delete: type_description_delete): Promise; /** */ function mysql_formulation_select(description_select: type_description_select): type_query; /** */ function mysql_query_select(subject: type_mysql_subject, description_select: type_description_select): Promise>>; /** */ function mysql_database(parameters: type_mysql_parameters): type_database; } declare namespace lib_plankton.database { /** * @author fenris */ class class_mysql implements interface_database { private subject; constructor(parameters: type_mysql_parameters); wrap_name(name: any): string; query_free_get(query: any): Promise; query_free_put(query: any): Promise; query_free_set(query: any): Promise; query_create_table(description_create_table: any): Promise; query_insert(description_insert: any): Promise; query_update(description_update: any): Promise; query_delete(description_delete: any): Promise; query_select(description_select: any): Promise[]>; } } declare namespace lib_plankton.storage { /** * implements the idea of a database, which houses datasets (type_value) and manages their access by ids or sth. similar (type_key) * * @author fenris */ type type_store = { /** * shall prepare the storage instance for use * * @author fenris */ setup(input: type_setup_input): Promise; /** * shall insert a new dataset and return its automatically assign key * * @author fenris */ create(value: type_value): Promise; /** * shall modify an existing dataset * * @author fenris */ update(key: type_key, value: type_value): Promise; /** * shall remove an existing dataset * * @author fenris */ delete(key: type_key): Promise; /** * shall get an existing dataset by its key * * @author fenris */ read(key: type_key): Promise; /** * shall list keys and previews of existing datasets, which match a certain search term * * @author fenris */ search(term?: (null | type_searchterm)): Promise>; }; /** * for class wrappers */ type interface_store = type_store; } declare namespace lib_plankton.storage { /** * implements the idea of a storage without managed keys * * @author fenris */ type type_chest = { /** * shall prepare the storage instance for use * * @author fenris */ setup(input: type_setup_input): Promise; /** * shall remove all items */ clear(): Promise; /** * shall insert a new or modify an existing dataset and return whether it is new * * @author fenris */ write(key: type_key, value: type_value): Promise; /** * shall remove an existing dataset * * @author fenris */ delete(key: type_key): Promise; /** * shall get an existing dataset by its key * * @author fenris */ read(key: type_key): Promise; /** * shall list keys and previews of existing datasets, which match a certain search term * * @author fenris */ search(term?: (null | type_searchterm)): Promise>; }; /** * for class wrappers */ type interface_chest = type_chest; } declare namespace lib_plankton.storage.memory { /** * @author fenris */ type type_subject = { data: Record; }; /** */ type type_parameters = {}; /** * @author fenris */ function make(parameters: type_parameters): type_subject; /** * @author fenris */ function clear(subject: type_subject): void; /** * @author fenris */ function write(subject: type_subject, key: string, value: type_value): boolean; /** * @author fenris */ function delete_(subject: type_subject, key: string): void; /** * @author fenris */ function read(subject: type_subject, key: string): type_value; /** * @author fenris */ function list(subject: type_subject): Array; /** * @author fenris */ function search(subject: type_subject, term: (null | string)): Array<{ key: string; preview: string; }>; /** * @author fenris */ function implementation_chest(parameters: type_parameters): type_chest; } declare namespace lib_plankton.storage.memory { /** * @author fenris */ class class_chest implements type_chest { private subject; constructor(parameters: type_parameters); setup(input: any): Promise; clear(): Promise; write(key: any, value: any): Promise; delete(key: any): Promise; read(key: any): Promise>; search(term: any): Promise<{ key: string; preview: string; }[]>; } } declare namespace lib_plankton.storage.filesystem { /** * @author fenris */ type type_subject = { nodemodule: any; }; /** */ type type_parameters = {}; /** * @author fenris */ function make(parameters: type_parameters): type_subject; /** */ function clear(subject: type_subject): Promise; /** * @author fenris */ function write(subject: type_subject, path: string, content: Buffer): Promise; /** * @author fenris */ function delete_(subject: type_subject, path: string): Promise; /** * @author fenris */ function read(subject: type_subject, path: string): Promise; /** */ function implementation_chest(parameters: type_parameters): type_chest; } declare namespace lib_plankton.storage.filesystem { /** * @author fenris */ class class_chest implements type_chest { private subject; constructor(parameters: type_parameters); setup(input: any): Promise; clear(): Promise; write(key: any, value: any): Promise; delete(key: any): Promise; read(key: any): Promise; search(searchterm: any): Promise<{ key: string; preview: void; }[]>; } } declare namespace lib_plankton.storage { /** */ type type_sql_table_autokey_search_term = { expression: string; arguments: Record; }; /** */ type type_sql_table_autokey_subject = { database_implementation: lib_plankton.database.type_database; table_name: string; key_name: string; }; /** */ type type_sql_table_autokey_parameters = { database_implementation: lib_plankton.database.type_database; table_name: string; key_name: string; }; /** */ function sql_table_autokey_make(parameters: type_sql_table_autokey_parameters): type_sql_table_autokey_subject; /** */ function sql_table_autokey_setup(subject: type_sql_table_autokey_subject, description_create_table: lib_plankton.database.type_description_create_table): Promise; /** */ function sql_table_autokey_create(subject: type_sql_table_autokey_subject, value: Record): Promise; /** */ function sql_table_autokey_update(subject: type_sql_table_autokey_subject, key: int, value: Record): Promise; /** */ function sql_table_autokey_delete(subject: type_sql_table_autokey_subject, key: int): Promise; /** */ function sql_table_autokey_read(subject: type_sql_table_autokey_subject, key: int): Promise>; /** * @todo correct preview */ function sql_table_autokey_search(subject: type_sql_table_autokey_subject, term: (null | type_sql_table_autokey_search_term)): Promise; }>>; /** */ function sql_table_autokey_store(parameters: type_sql_table_autokey_parameters): type_store, lib_plankton.database.type_description_create_table, type_sql_table_autokey_search_term, Record>; } declare namespace lib_plankton.storage { /** * @author fenris */ class class_sql_table_autokey implements type_store, lib_plankton.database.type_description_create_table, string, Record> { private subject; constructor(parameters: type_sql_table_autokey_parameters); setup(input: any): Promise; create(value: any): Promise; update(key: any, value: any): Promise; delete(key: any): Promise; read(key: any): Promise>; search(term: any): Promise<{ key: number; preview: Record; }[]>; } } declare namespace lib_plankton.storage.sql_table_common { /** */ type type_sql_table_common_search_term = { expression: string; arguments: Record; }; /** */ type type_subject = { database_implementation: lib_plankton.database.type_database; table_name: string; key_names: Array; }; /** */ type type_parameters = { database_implementation: lib_plankton.database.type_database; table_name: string; key_names: Array; }; /** */ function make(parameters: type_parameters): type_subject; /** */ function setup(subject: type_subject, description_create_table: lib_plankton.database.type_description_create_table): Promise; /** */ function clear(subject: type_subject): Promise; /** * @todo optimize: avoid read */ function write(subject: type_subject, key: Array, value: Record): Promise; /** */ function delete_(subject: type_subject, key: Array): Promise; /** */ function read(subject: type_subject, key: Array): Promise>; /** * @todo correct preview */ function search(subject: type_subject, term: (null | type_sql_table_common_search_term)): Promise; preview: Record; }>>; /** */ function chest(parameters: type_parameters): type_chest, Record, lib_plankton.database.type_description_create_table, type_sql_table_common_search_term, Record>; } declare namespace lib_plankton.storage.sql_table_common { /** * @author fenris */ class class_chest implements type_chest, Record, lib_plankton.database.type_description_create_table, type_sql_table_common_search_term, Record> { private subject; constructor(parameters: type_parameters); setup(input: any): Promise; clear(): Promise; write(key: any, value: any): Promise; delete(key: any): Promise; read(key: any): Promise>; search(term: any): Promise<{ key: any[]; preview: Record; }[]>; } } declare namespace lib_plankton.session { /** */ type type_session = { key: string; name: string; expiry: int; data: any; }; /** */ function begin(name: string, options?: { lifetime?: int; data?: any; }): Promise; /** */ function get(key: string): Promise; /** */ function end(key: string): Promise; /** */ function setup(options?: { key_length?: int; key_max_attempts?: int; default_lifetime?: int; data_chest?: lib_plankton.storage.type_chest; clear?: boolean; }): Promise; } declare namespace lib_plankton.json { /** */ type type_source = any; /** */ type type_target = string; /** * @author fenris */ export function encode(source: type_source, options?: { formatted?: boolean; }): type_target; /** * @author fenris */ export function decode(target: type_target): type_source; /** * @author fenris */ export function implementation_code(): lib_plankton.code.type_code; export {}; } declare namespace lib_plankton.json { /** * @author fenris */ class class_json implements lib_plankton.code.interface_code { /** * @author fenris */ constructor(); /** * @implementation * @author fenris */ encode(x: any): string; /** * @implementation * @author fenris */ decode(x: string): any; } } declare namespace lib_plankton.object { /** * @author fenris * @deprecated use the "??" operator instead */ function fetch(object: Object, fieldname: string, options?: { fallback?: type_value; escalate?: boolean; }): type_value; /** */ function map(object_from: Record, transformator: ((value_from: type_from, key?: string) => type_to)): Record; /** * gibt ein Objekt mit bestimmten Einträgen des Eingabe-Objekts zurück */ function filter(object_from: Record, predicate: ((value_from: type_value, key?: string) => boolean)): Record; /** * wandelt ein Array mit Einträgen der Form {key,value} in ein entsprechendes Objekt um * * @deprecated use Object.fromEntries instead! */ function from_array(array: Array<{ key: string; value: type_value; }>): Record; /** * wandelt ein Objekt in ein entsprechendes Array mit Einträgen der Form {key,value} um * * @deprecated use Object.entries insetad! */ function to_array(object: Record): Array<{ key: string; value: type_value; }>; /** * gibt eine Liste von Schlüsseln eines Objekts zurück * * @deprecated use Object.keys instead! */ function keys(object: Record): Array; /** * gibt eine Liste von Werten eines Objekts zurück * * @deprecated use Object.values instead! */ function values(object: Record): Array; /** * liest ein Baum-artiges Objekt an einer bestimmten Stelle aus */ function path_read(object: Object, path: string, options?: { fallback?: type_value; escalate?: boolean; }): type_value; /** * schreibt einen Wert an eine bestimmte Stelle in einem Baum-artigen Objekt */ function path_write(object: Object, path: string, value: type_value, construct?: boolean): void; /** * prüft ob ein Objekt einem bestimmten Muster entspricht * * @deprecated not very useful */ function matches(object: Record, pattern: Record, options?: { collate?: ((value_pattern: type_value_pattern, value_object: type_value_object) => boolean); }): boolean; /** * erzeugt eine Projektion eines Baum-artigen Objekts in ein Listen-artiges Objekt */ function flatten(value: any, options?: { separator?: string; key_for_array_element?: ((index: int) => string); }): Record; /** * @deprecated use Object.assign instead! */ function clash(x: Record, y: Record, options?: { overwrite?: boolean; hooks?: { existing?: ((key?: string, value_old?: any, value_new?: any) => void); }; }): Record; /** * @deprecated use Object.assign instead! */ function patch(core: (null | Record), mantle: (null | Record), options?: { deep?: boolean; path?: (null | string); }): void; /** * @deprecated use Object.assign instead! */ function patched(core: Record, mantle: Record, options?: { deep?: boolean; }): Record; /** * @deprecated use Object.assign instead! */ function attached(object: Record, key: string, value: any): Record; /** * @author fenris */ function copy(object: Record): Record; } declare namespace lib_plankton.markdown { /** * @author fenris */ function code(content: string): string; /** * @author fenris */ function paragraph(content: string): string; /** * @author fenris */ function sectionhead(level: int, content: string): string; } declare namespace lib_plankton.api { /** */ enum enum_checklevel { none = "none", soft = "soft", hard = "hard" } /** * @author fenris */ type type_action = { name: string; active: ((version: (null | string)) => boolean); execution: ((version: (null | string), environment: any, input: any) => Promise); restriction: ((version: (null | string), environment: any) => Promise); input_shape: ((version: (null | string)) => lib_plankton.shape.type_shape); output_shape: ((version: (null | string)) => lib_plankton.shape.type_shape); title: (null | string); description: (null | string); }; /** * @author fenris */ type type_api = { title: string; actions: Record; }; /** */ class class_error_permission_denied extends Error { } } declare namespace lib_plankton.api { /** * @author fenris */ function make(title: string): type_api; /** * @throws Error if a action with the given name has already been registered * @author fenris */ function register(api: type_api, name: string, options?: { active?: ((version: (null | string)) => boolean); execution?: ((version: (null | string), environment: any, input: any) => Promise); restriction?: ((version: (null | string), input: any) => Promise); input_shape?: ((version: (null | string)) => lib_plankton.shape.type_shape); output_shape?: ((version: (null | string)) => lib_plankton.shape.type_shape); title?: (null | string); description?: (null | string); }): void; /** * @throws Error if not found * @author fenris */ function get_action(api: type_api, name: string): type_action; /** * @author fenris */ function call(api: type_api, name: string, options?: { version?: (null | string); input?: any; environment?: Record; checklevel_restriction?: enum_checklevel; checklevel_input?: enum_checklevel; checklevel_output?: enum_checklevel; }): Promise; /** * @author fenris */ function generate_documentation_for_action(api: type_api, name: string, options?: { version?: (null | string); }): string; /** * @author fenris */ function generate_documentation(api: type_api, options?: { version?: (null | string); }): string; } declare namespace lib_plankton.api { /** * @author fenris */ class class_api { /** * @author fenris */ private subject; /** * @author fenris */ private constructor(); /** * @author fenris */ static create(name: string): class_api; /** * @author fenris */ register(name: string, options?: { active?: ((version: (null | string)) => boolean); execution?: ((version: (null | string), environment: any, input: any) => lib_plankton.call.type_promise); restriction?: ((version: (null | string), input: any) => Promise); input_shape?: ((version: (null | string)) => lib_plankton.shape.type_shape); output_shape?: ((version: (null | string)) => lib_plankton.shape.type_shape); title?: (null | string); description?: (null | string); }): void; /** * @author fenris */ call(name: string, options?: { version?: (null | string); input?: any; environment?: Record; checklevel_restriction?: enum_checklevel; checklevel_input?: enum_checklevel; checklevel_output?: enum_checklevel; }): lib_plankton.call.type_promise; /** * @author fenris */ generate_documentation_for_action(name: string): string; /** * @author fenris */ generate_documentation(): string; } } declare namespace lib_plankton.http_base { /** */ type type_request = { scheme: ("http" | "https"); host: (null | string); path: string; version: string; method: type_method; query: (null | string); headers: Record; body: (null | Buffer); }; /** */ type type_response = { version: (null | string); status_code: type_status_code; headers: Record; body: (null | Buffer); }; } declare namespace lib_plankton.http_base { /** */ function encode_request(encode_method: ((method: type_method) => string), request: type_request): string; /** */ function decode_request(decode_method: ((method_raw: string) => type_method), has_body: ((method: type_method) => boolean), request_raw: string): type_request; /** */ function encode_response(encode_status_code: ((status_code: type_status_code) => string), get_status_text: ((status_code: type_status_code) => string), response: type_response): string; /** */ function decode_response(decode_status_code: ((status_code_raw: string) => type_status_code), response_raw: string): type_response; /** * executes an HTTP request * * @todo define type_signal */ function call(has_body: ((method: type_method) => boolean), encode_method: ((method: type_method) => string), decode_status_code: ((status_code_raw: string) => type_status_code), request: type_request, { "timeout": option_timeout, "follow_redirects": option_follow_redirects, "implementation": option_implementation, }?: { timeout?: (null | float); follow_redirects?: boolean; implementation?: ("fetch" | "http_module"); }): Promise>; } declare namespace lib_plankton.http { /** * @author fenris */ enum enum_method { options = "options", head = "head", get = "get", delete = "delete", post = "post", put = "put", patch = "patch" } /** */ enum enum_status_code { continue_ = 100, switching_protocols = 101, early_hints = 103, ok = 200, created = 201, accepted = 202, non_authoritative_information = 203, no_content = 204, reset_content = 205, partial_coentent = 206, multiple_choices = 300, moved_permanently = 301, found = 302, see_other = 303, not_modified = 304, temporary_redirect = 307, permanent_redirect = 308, bad_request = 400, unauthorized = 401, payment_required = 402, forbidden = 403, not_found = 404, method_not_allowed = 405, not_acceptable = 406, proxy_authentication_required = 407, request_timeout = 408, conflict = 409, gone = 410, length_required = 411, precondition_failed = 412, payload_too_large = 413, uri_too_long = 414, unsupported_media_type = 415, range_not_satisfiable = 416, expectation_failed = 417, i_m_a_teapot = 418, unprocessable_entity = 422, too_early = 425, upgrade_required = 426, precondition_required = 428, too_many_requests = 429, request_header_fields_too_large = 431, unavailable_for_legal_reasons = 451, internal_server_error = 500, not_implemented = 501, bad_gateway = 502, service_unavailable = 503, gateway_timeout = 504, http_version_not_supported = 505, variant_also_negotiates = 506, insufficient_storage = 507, loop_detected = 508, not_extended = 510, network_authentication = 511 } /** * @author fenris */ type type_request = lib_plankton.http_base.type_request; /** * @author fenris */ type type_response = lib_plankton.http_base.type_response; } declare namespace lib_plankton.http { /** * @author fenris */ function encode_method(method: enum_method): string; /** * @author fenris */ function decode_method(method_raw: string): enum_method; /** * @author fenris */ function has_body(method: enum_method): boolean; /** * @author fenris */ function encode_request(request: type_request): string; /** * @author fenris */ function decode_request(request_raw: string): type_request; /** * @author fenris */ function encode_response(response: type_response): string; /** * @author fenris */ function decode_response(response_raw: string): type_response; /** * executes an HTTP request * * @todo define type_signal */ function call(request: type_request, { "timeout": option_timeout, "follow_redirects": option_follow_redirects, "implementation": option_implementation, }?: { timeout?: (null | float); follow_redirects?: boolean; implementation?: ("fetch" | "http_module"); }): Promise; } declare namespace lib_plankton.rest_base { /** */ type type_oas_schema = ({} | { nullable: boolean; } | { type: "boolean"; nullable?: boolean; enum?: Array; } | { type: "integer"; nullable?: boolean; enum?: Array; } | { type: "number"; nullable?: boolean; enum?: Array; } | { type: "string"; nullable?: boolean; enum?: Array; } | { type: "array"; nullable?: boolean; items: type_oas_schema; } | { type: "object"; nullable?: boolean; additionalProperties?: (false | type_oas_schema); properties: Record; required: Array; }); /** */ type type_execution = ((stuff: { headers: Record; path_parameters: Record; query_parameters: Record; input: (null | type_input); }) => Promise<{ status_code: int; data: type_output; headers?: (null | Record); }>); /** */ type type_restriction = ((stuff: { headers: Record; path_parameters: Record; query_parameters: Record; }) => Promise); /** */ type type_operation = { action_name: string; query_parameters: ((version: (null | string)) => Array<{ name: string; description: (null | string); required: boolean; }>); input_schema: ((version: (null | string)) => type_oas_schema); output_schema: ((version: (null | string)) => type_oas_schema); request_body_mimetype: ((version: (null | string)) => string); request_body_decode: ((version: (null | string)) => (http_request_body: Buffer, http_request_header_content_type: (null | string)) => any); response_body_mimetype: ((version: (null | string)) => string); response_body_encode: ((version: (null | string)) => ((output: any) => (null | Buffer))); }; /** */ type type_routenode = { operations: Record>; sub_branch: Record; sub_wildcard: (null | { name: string; node: type_routenode; }); }; /** */ type type_rest = { api: lib_plankton.api.type_api; routetree: type_routenode; versioning_method: ("none" | "path" | "header" | "query"); versioning_header_name: (null | string); versioning_query_key: (null | string); header_parameters: Array<{ name: string; description: (null | string); required: boolean; }>; set_access_control_headers: boolean; authentication: ({ kind: "none"; data: {}; } | { kind: "key_header"; data: { name: string; }; }); }; /** */ type type_action_options = { active?: ((version: (null | string)) => boolean); restriction?: ((version: (null | string)) => type_restriction); execution?: ((version: (null | string)) => type_execution); title?: ((version: (null | string)) => (null | string)); description?: ((version: (null | string)) => (null | string)); query_parameters?: ((version: (null | string)) => Array<{ name: string; description: (null | string); required: boolean; }>); input_schema?: ((version: (null | string)) => type_oas_schema); output_schema?: ((version: (null | string)) => type_oas_schema); request_body_mimetype?: ((version: (null | string)) => string); request_body_decode?: ((version: (null | string)) => (http_request_body: Buffer, http_request_header_content_type: (null | string)) => Promise); response_body_mimetype?: ((version: (null | string)) => string); response_body_encode?: ((version: (null | string)) => (output: any) => Promise); }; } declare namespace lib_plankton.rest_base { /** */ function make(encode_http_method: ((http_method: type_http_method) => string), { "title": option_title, "versioning_method": option_versioning_method, "versioning_header_name": option_versioning_header_name, "versioning_query_key": option_versioning_query_key, "header_parameters": option_header_parameters, "set_access_control_headers": option_set_access_control_headers, "authentication": option_authentication, "actions": option_actions, }?: { title?: (null | string); versioning_method?: ("none" | "path" | "header" | "query"); versioning_header_name?: (null | string); versioning_query_key?: (null | string); header_parameters?: Array<{ name: string; description: (null | string); required: boolean; }>; set_access_control_headers?: boolean; authentication?: ({ kind: "none"; data: {}; } | { kind: "key_header"; data: { name: string; }; }); actions?: Array<{ http_method: type_http_method; path: string; options: type_action_options; }>; }): type_rest; /** */ function register(encode_http_method: ((http_method: type_http_method) => string), rest: type_rest, http_method: type_http_method, path: string, { "active": option_active, "execution": option_execution, "restriction": option_restriction, "title": option_title, "description": option_description, "query_parameters": option_query_parameters, "input_schema": option_input_schema, "output_schema": option_output_schema, "request_body_mimetype": option_request_body_mimetype, "request_body_decode": option_request_body_decode, "response_body_mimetype": option_response_body_mimetype, /** * @todo no "from"? */ "response_body_encode": option_response_body_encode, }?: type_action_options): void; /** * @todo check request body mimetype? * @todo check query paramater validity */ function call(encode_http_method: ((http_method: type_http_method) => string), is_options_request: ((http_method: type_http_method) => boolean), decode_status_code: ((status_code_raw: int) => type_http_status_code), rest: type_rest, http_request: lib_plankton.http_base.type_request, { "checklevel_restriction": option_checklevel_restriction, "checklevel_input": option_checklevel_input, "checklevel_output": option_checklevel_output, "set_content_length": option_set_content_length, }?: { checklevel_restriction?: lib_plankton.api.enum_checklevel; checklevel_input?: lib_plankton.api.enum_checklevel; checklevel_output?: lib_plankton.api.enum_checklevel; set_content_length?: boolean; }): Promise>; /** * @see https://swagger.io/specification/#openrest-object */ function to_oas(http_request_method_to_oas: ((http_request_method: type_method) => string), has_body: ((method: type_method) => boolean), rest: type_rest, { "version": option_version, "servers": option_servers, }?: { version?: (null | string); servers?: Array; }): any; } declare namespace lib_plankton.rest_http { /** */ type type_oas_schema = lib_plankton.rest_base.type_oas_schema; /** */ type type_execution = lib_plankton.rest_base.type_execution; /** */ type type_restriction = lib_plankton.rest_base.type_restriction; /** */ type type_operation = lib_plankton.rest_base.type_operation; /** */ type type_routenode = lib_plankton.rest_base.type_routenode; /** */ type type_rest = lib_plankton.rest_base.type_rest; } declare namespace lib_plankton.rest_http { /** */ function make(options?: { title?: (null | string); versioning_method?: ("none" | "path" | "header" | "query"); versioning_header_name?: (null | string); versioning_query_key?: (null | string); header_parameters?: Array<{ name: string; description: (null | string); required: boolean; }>; set_access_control_headers?: boolean; authentication?: ({ kind: "none"; data: {}; } | { kind: "key_header"; data: { name: string; }; }); actions?: Array<{ http_method: lib_plankton.http.enum_method; path: string; options: lib_plankton.rest_base.type_action_options; }>; }): type_rest; /** */ function register(rest: type_rest, http_method: lib_plankton.http.enum_method, path: string, options: lib_plankton.rest_base.type_action_options): void; /** * @todo check request body mimetype? * @todo check query paramater validity * @todo improve status code mapping */ function call(rest: type_rest, http_request: lib_plankton.http.type_request, { "checklevel_restriction": option_checklevel_restriction, "checklevel_input": option_checklevel_input, "checklevel_output": option_checklevel_output, "set_content_length": option_set_content_length, }?: { checklevel_restriction?: lib_plankton.api.enum_checklevel; checklevel_input?: lib_plankton.api.enum_checklevel; checklevel_output?: lib_plankton.api.enum_checklevel; set_content_length?: boolean; }): Promise; /** * @see https://swagger.io/specification/#openrest-object */ function to_oas(rest: type_rest, options?: { version?: (null | string); servers?: Array; }): any; } declare namespace lib_plankton.server { /** */ type type_metadata = { ip_address: string; }; /** */ type type_subject = { host: string; port: int; threshold: (null | float); handle: ((input: Buffer, metadata?: type_metadata) => Promise); serverobj: any; }; /** */ function make(handle: ((input: string, metadata?: type_metadata) => Promise), options?: { host?: string; port?: int; threshold?: (null | float); }): type_subject; /** * @deprecated */ function make_old(port: int, handle: ((input: string, metadata?: type_metadata) => Promise)): type_subject; /** * @see https://nodejs.org/api/net.html#serverlistenport-host-backlog-callback */ function start(subject: type_subject): Promise; /** */ function kill(subject: type_subject): void; } declare namespace lib_plankton.server { /** * @author fenris */ class class_server { /** * @author fenris */ protected subject: type_subject; /** * @author fenris */ constructor(handle: ((input: Buffer, metadata?: type_metadata) => Promise), options?: { host?: string; port?: int; }); /** * @author fenris */ start(): Promise; /** * @author fenris */ kill(): void; } } declare var lib_server: typeof lib_plankton.server; declare namespace lib_plankton.args { /** */ enum enum_environment { cli = "cli", url = "url" } /** */ enum enum_kind { positional = "positional", volatile = "volatile" } /** */ enum enum_type { boolean = "boolean", integer = "int", float = "float", string = "string" } /** */ enum enum_mode { replace = "replace", accumulate = "accumulate" } } declare namespace lib_plankton.args { /** * @author fenris */ class class_argument { /** * @author fenris */ protected name: string; /** * @author fenris */ protected kind: enum_kind; /** * @author fenris */ protected type: enum_type; /** * @author fenris */ protected mode: enum_mode; /** * @author fenris */ protected default_: any; /** * @author fenris */ protected info: string; /** * @author fenris */ protected parameters: Object; /** * @author fenris */ protected hidden: boolean; /** * @author fenris */ constructor({ "name": name, "type": type, "kind": kind, "mode": mode, "default": default_, "info": info, "parameters": parameters, "hidden": hidden, }: { name: string; type?: enum_type; kind?: enum_kind; mode?: enum_mode; default?: any; info?: string; parameters?: Object; hidden?: boolean; }); /** * @author fenris */ static positional({ "name": name, "type": type, "mode": mode, "default": default_, "info": info, "hidden": hidden, "index": index, }: { name: string; type?: enum_type; mode?: enum_mode; default?: any; info?: string; hidden?: boolean; index: int; }): class_argument; /** * @author fenris */ static volatile({ "name": name, "type": type, "mode": mode, "default": default_, "info": info, "hidden": hidden, "indicators_short": indicators_short, "indicators_long": indicators_long, }: { name: string; type?: enum_type; mode?: enum_mode; default?: any; info?: string; hidden?: boolean; indicators_short: Array; indicators_long: Array; }): class_argument; /** * @author fenris */ check(): boolean; /** * @author fenris */ name_get(): string; /** * @author fenris */ kind_get(): enum_kind; /** * @author fenris */ type_get(): enum_type; /** * @author fenris */ mode_get(): enum_mode; /** * @author fenris */ default_get(): any; /** * @author fenris */ parameters_get(): Object; /** * @author fenris */ hidden_get(): boolean; /** * @author fenris */ toString(): string; /** * @author fenris */ indicator_main(): string; /** * @author fenris */ pattern_value(): string; /** * @author fenris */ extract(raw: string): any; /** * @author fenris */ assign(data: Object, target: string, raw: string): void; /** * @author fenris */ make(data: Object, target: string): string; /** * @author fenris */ generate_help(): string; } } declare namespace lib_plankton.args { /** * @author fenris */ var verbosity: int; /** * @author fenris * @todo check validity */ class class_handler { /** * @author fenris */ protected arguments_: { [name: string]: class_argument; }; /** * @author fenris */ constructor(arguments_: { [name: string]: class_argument; }); /** * @author fenris */ filter(kind: enum_kind): { [name: string]: class_argument; }; /** * @author fenris */ read(environment: enum_environment, input: string, data?: { [name: string]: any; }): { [name: string]: any; }; /** * @author fenris * @todo handle if the data object doesn't have the required field or the type is wrong or sth. */ write(environment: enum_environment, data: { [name: string]: any; }): string; /** * @desc manpage-like info-sheet * @author fenris */ generate_help({ "programname": programname, "author": author, "description": description, "executable": executable, }: { programname?: string; author?: string; description?: string; executable?: string; }): string; } } declare namespace lib_plankton.translate { /** * @author fenris */ type type_package_meta = { identifier: string; name?: string; }; /** * @author fenris */ type type_package = { meta: type_package_meta; tree: { [id: string]: string; }; }; /** * @desc the level of verbosity, specifiying how much output the system shall provide about its actions * @author fenris */ var _verbosity: int; /** * @desc moves a language to the top of the order, making it the primary one * @author fenris */ function promote(identifier: string): void; /** * @desc adds a package to the sytem * @author fenris */ function add(package_: type_package): void; /** * @desc integrates a package to the system, i.e. creates a new one if none existed so far or merges with an existing one * @author fenris */ function feed(package_: type_package): void; /** * @desc tries to retrieve a translation for a specific package identifier * @author fenris */ function fetch(identifier: string, path: string, args?: { [id: string]: string; }): lib_plankton.pod.type_pod; /** * @desc retrieves a string by going through the order and trying to fetch it for the current entry * @author fenris */ function get(path: string, args?: { [id: string]: string; }, fallback?: string): string; /** * @author fenris */ function list(): Array; /** * @author fenris * @todo get rid of this; it's currenly needed only for the cdh-internal lib_completion */ function paths(): Array; /** * @author fenris */ function initialize({ "logprefix": logprefix, "verbosity": verbosity, "packages": packages, "order": order, "autopromote": autopromote, }?: { logprefix?: string; verbosity?: int; packages?: Array; order?: Array; autopromote?: boolean; }): Promise; } declare namespace lib_plankton.translate { /** * @author fenris */ function iso_639_1_to_iso_639_2(iso6391: string): string; /** * @author fenris */ function stance(str: string): string; }