@hcikit/workflow
Version:
A workflow manager for running experiments.
88 lines (87 loc) • 2.37 kB
TypeScript
/**
* Shuffles array in place. ES6 version
* @param {Array} a An array containing the items.
*/
export declare function shuffle<T>(a: Array<T>): Array<T>;
/**
* Returns a random choice from the array.
* @param {Array} a An array containing the options.
*/
export declare function randomChoice<T>(a: Array<T>): T;
/**
* Returns a random choice from the array.
* @param {Array} a An array containing the options.
*/
export declare function randomChoiceNoReplacement<T>(a: Array<T>): T;
/**
* Returns a random number between min (inclusive) and max (exclusive)
*/
export declare function randInt(min: number, max: number): number;
/**
* Generates a random GUID.
*/
export declare function uuidv4(): string;
/**
* Generates a random string.
*/
export declare function randomString(): string;
type OS = "Windows" | "MacOS" | "UNIX" | "Linux" | "Unknown";
/**
* Gets the OS of the user.
*/
export declare function getOS(): OS;
/**
* Grabs a bunch of info from the browser for logging. Tries not to include too much information but there is more such as the location API etc.
*/
export declare function getBrowserInfo(): {
browserName: string;
browserEngine: string;
browserVersion1a: string;
browserVersion1b: string;
browserLanguage: string;
browserOnline: boolean;
browserPlatform: string;
sizeScreenW: number;
sizeScreenH: number;
sizeInW: number;
sizeInH: number;
sizeAvailW: number;
sizeAvailH: number;
scrColorDepth: number;
scrPixelDepth: number;
};
export declare function getUrlParams(defaults?: {
participant: string;
WORKER_ID: string;
ASSIGNMENT_ID: string;
HIT_ID: string;
}): {
participant: string;
WORKER_ID: string;
ASSIGNMENT_ID: string;
HIT_ID: string;
};
export declare function getAllMetadata(): {
os: OS;
browserName: string;
browserEngine: string;
browserVersion1a: string;
browserVersion1b: string;
browserLanguage: string;
browserOnline: boolean;
browserPlatform: string;
sizeScreenW: number;
sizeScreenH: number;
sizeInW: number;
sizeInH: number;
sizeAvailW: number;
sizeAvailH: number;
scrColorDepth: number;
scrPixelDepth: number;
TZ?: string | undefined;
participant: string;
WORKER_ID: string;
ASSIGNMENT_ID: string;
HIT_ID: string;
};
export {};